Tapatybės patvirtinimas

1Sukurkite API raktą

Programai prijungti prie parduotuvės reikia API rakto. Administravimo skydelyje pasirinkite jo teises, kurios nustato, kokius duomenis programa gali skaityti ir ką gali keisti.

Taip pat galite nurodyti IP adresus, iš kurių programa jungsis prie API. Jei juos nurodysite, raktą bus galima naudoti tik iš šių adresų. Tada sukurkite API raktą.

2Gauk prieigos žetoną

Prieigos žetonas leidžia siųsti užklausas neperduodant API rakto kiekvienoje užklausoje. Kai žetono nebereikia, galite jį atšaukti.

Kartu su prieigos žetonu gausi savo parduotuvės leidimus ir API užklausų limitus.

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

3Siųsk API užklausas

Siųsdamas API užklausas naudok gautą žetoną. Neviršyk parduotuvės užklausų limitų. Prieiga prie operacijų taip pat priklauso nuo tavo plano leidimų.

Jei užklausoms reikia pasirinkti kalbą ar rinką, gaukite parduotuvės kontekstą. Gausite galimas kalbas ir rinkas su jų kodais bei identifikatoriais.

4Atšauk žetoną

Atšaukti žetoną neprivaloma. Jei jį naudojate vienkartinei užduočiai, rekomenduojame baigus darbą jį atšaukti. Jei žetono neatšauksite rankiniu būdu, jis galios iki nustatyto laiko pabaigos. Vėliau jo naudoti nebebus galima.

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