Preverjanje pristnosti

1Ustvarite ključ API

Za povezavo aplikacije s trgovino potrebujete ključ API. V skrbniški plošči izberite dovoljenja, ki določajo, katere podatke sme aplikacija brati in kaj sme spreminjati.

Določite lahko tudi naslove IP, s katerih bo aplikacija dostopala do API-ja. Če jih navedete, bo ključ mogoče uporabljati samo s teh naslovov. Nato ustvarite ključ API.

2Pridobi žeton za dostop

Dostopni žeton omogoča pošiljanje zahtev brez pošiljanja ključa API v vsaki zahtevi. Ko ga ne potrebujete več, ga lahko prekličete.

Skupaj z žetonom prejmeš dovoljenja in omejitve zahtev API svoje trgovine. S

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

3Pošiljaj zahteve API

Pri pošiljanju zahtev API uporabi prejeti žeton. Upoštevaj omejitve zahtev svoje trgovine. Dostop do posameznih operacij je odvisen tudi od dovoljenj tvojega paketa.

Če morate za zahteve izbrati jezik ali trg, pridobite kontekst trgovine. Prejeli boste razpoložljive jezike in trge z njihovimi kodami in identifikatorji.

4Prekliči žeton

Preklic žetona ni obvezen. Če ga uporabljate za enkratno opravilo, priporočamo preklic po končanem delu. Če žetona ne prekličete ročno, ostane veljaven do konca nastavljenega časa. Nato ga ni več mogoče uporabljati.

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