Autentifikacija

1Napravite API ključ

Za povezivanje aplikacije sa prodavnicom potreban vam je API ključ. U administrativnom panelu izaberite ovlašćenja koja određuju koje podatke aplikacija sme da čita i šta sme da menja.

Možete navesti i IP adrese sa kojih će aplikacija pristupati API-ju. Ako ih navedete, ključ može da se koristi samo sa tih adresa. Zatim napravite API ključ.

2Preuzmi pristupni token

Pristupni token omogućava slanje zahteva bez slanja API ključa u svakom zahtevu. Možete ga opozvati kada vam više nije potreban.

Uz token dobijaš dozvole i ograničenja API zahteva svoje prodavnice.

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"
  }
}

3Šalji API zahteve

Koristi dobijeni token pri slanju API zahteva. Poštuj ograničenja zahteva svoje prodavnice. Pristup pojedinačnim operacijama zavisi i od dozvola tvog plana.

Ako za zahteve treba da izaberete jezik ili tržište, preuzmite kontekst prodavnice. Dobićete dostupne jezike i tržišta sa njihovim kodovima i identifikatorima.

4Opozovi token

Opoziv tokena nije obavezan. Ako ga koristite za jednokratan zadatak, preporučujemo da ga opozovete nakon završetka. Ako ga ne opozovete ručno, token ostaje važeći do isteka zadatog vremena. Nakon toga više ne može da se koristi.

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"
  }
}