Autentifikacija

1Izradite API ključ

Za povezivanje aplikacije s trgovinom potreban vam je API ključ. U administracijskoj ploči odaberite ovlasti koje određuju koje podatke aplikacija smije čitati i što smije mijenjati.

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

2Dohvati pristupni token

Pristupni token omogućuje slanje zahtjeva bez slanja API ključa u svakom zahtjevu. Možete ga opozvati kada vam više ne treba.

Uz token dobivaš dopuštenja i ograničenja API zahtjeva svoje trgovine.

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 zahtjeve

Upotrebljavaj dobiveni token pri slanju API zahtjeva. Poštuj ograničenja zahtjeva svoje trgovine. Pristup pojedinim operacijama ovisi i o dopuštenjima tvojeg plana.

Ako za zahtjeve trebate odabrati jezik ili tržište, dohvatite kontekst trgovine. Dobit ćete dostupne jezike i tržišta s 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 valjan do isteka zadanog vremena. Nakon toga više se ne može koristiti.

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