Autentifikācija

1Izveidojiet API atslēgu

Lai savienotu lietotni ar veikalu, nepieciešama API atslēga. Administrēšanas panelī izvēlieties tās atļaujas, kas nosaka, kādus datus lietotne drīkst lasīt un ko tā drīkst mainīt.

Varat norādīt arī IP adreses, no kurām lietotne piekļūs API. Ja tās norādīsiet, atslēgu varēs izmantot tikai no šīm adresēm. Pēc tam izveidojiet API atslēgu.

2Iegūsti piekļuves marķieri

Piekļuves tokens ļauj sūtīt pieprasījumus, nenosūtot API atslēgu katrā pieprasījumā. Tokenu varat atsaukt, kad tas vairs nav vajadzīgs.

Kopā ar piekļuves marķieri saņemsi sava veikala atļaujas un API pieprasījumu ierobežojumus.

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

3Sūti API pieprasījumus

Izmanto saņemto marķieri, sūtot API pieprasījumus. Ievēro veikala pieprasījumu ierobežojumus. Piekļuve katrai darbībai ir atkarīga arī no tava plāna atļaujām.

Ja pieprasījumiem jāizvēlas valoda vai tirgus, iegūstiet veikala kontekstu. Saņemsiet pieejamās valodas un tirgus ar to kodiem un identifikatoriem.

4Anulē marķieri

Tokena atsaukšana nav obligāta. Ja to izmantojat vienreizējam uzdevumam, iesakām pēc darba beigām to atsaukt. Ja tokenu neatsauksiet manuāli, tas būs derīgs līdz noteiktā laika beigām. Pēc tam to vairs nevarēs izmantot.

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