Autentimine

1Loo API-võti

Rakenduse ühendamiseks poega vajad API-võtit. Vali halduspaneelis õigused, mis määravad, milliseid andmeid rakendus võib lugeda ja mida muuta.

Võid määrata ka IP-aadressid, millelt rakendus API-ga ühendub. Kui need määrad, saab võtit kasutada ainult nendelt aadressidelt. Seejärel loo API-võti.

2Hangi pääsutõend

Pääsutoken võimaldab saata päringuid ilma API-võtit igas päringus edastamata. Kui sa tõendit enam ei vaja, saad selle tühistada.

Koos pääsutõendiga saad oma poe õigused ja API päringute piirangud.

curl --disable --globoff --fail-with-body --silent --show-error \
  --proto '=https' --connect-timeout 5 --max-time 30 \
  --request POST \
  --url https://shop.onshopently.com/api/v1/auth/token \
  --header 'Authorization: ApiKey EXAMPLE_API_KEY' \
  --header 'Content-Type: application/json' \
  --data-raw '{"ttl_seconds":1800}'

{
  "data": {
    "access_token": "EXAMPLE_ACCESS_TOKEN",
    "expires_at": "2026-01-01T12:15:00Z",
    "expires_in": 1800,
    "permissions": [
      "orders.order:read"
    ],
    "rate_limits": {
      "auth_per_minute": 1,
      "read_per_minute": 2,
      "write_per_minute": 15
    },
    "token_type": "Bearer",
    "warnings": []
  },
  "meta": {
    "request_id": "example"
  }
}

3Saada API päringuid

Kasuta saadud pääsutõendit API päringute saatmisel. Järgi oma poe päringupiiranguid. Juurdepääs toimingutele sõltub ka sinu paketi õigustest.

Kui vajad päringute jaoks kindlat keelt või turgu, päri poe kontekst. Saad saadaolevad keeled ja turud koos nende koodide ning identifikaatoritega.

4Tühista pääsutõend

Tokeni tühistamine on vabatahtlik. Kui kasutad seda ühekordse ülesande jaoks, soovitame selle pärast töö lõpetamist tühistada. Kui sa tokenit käsitsi ei tühista, kehtib see määratud aja lõpuni. Pärast seda ei saa seda enam kasutada.

curl --disable --globoff --fail-with-body --silent --show-error \
  --proto '=https' --connect-timeout 5 --max-time 30 \
  --request POST \
  --url https://shop.onshopently.com/api/v1/auth/revoke \
  --header 'Authorization: ApiKey EXAMPLE_API_KEY' \
  --header 'Content-Type: application/json' \
  --data-raw '{"access_token":"EXAMPLE_ACCESS_TOKEN"}'

{
  "data": {
    "revoked": true
  },
  "meta": {
    "request_id": "example-request"
  }
}