Treci la conținut
ShopentlyLearn
Română

Autentificare

Creează o cheie API

Ai nevoie de o cheie API pentru a conecta aplicația la magazin. În panoul de administrare, alege permisiunile pentru a stabili ce date poate citi aplicația și ce poate modifica.

Poți indica și adresele IP de la care aplicația se va conecta la API. Dacă le completezi, cheia va putea fi folosită numai de la acele adrese. Apoi creează cheia API.

Obține un token de acces

Un token de acces permite trimiterea cererilor fără a include cheia API în fiecare cerere. Îl poți revoca atunci când nu mai ai nevoie de el.

Împreună cu tokenul primești permisiunile și limitele cererilor API ale magazinului tău.

POST/api/v1/auth/token

Cerere cURL 

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

Răspuns 

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

Trimite cereri API

Folosește tokenul primit când trimiți cereri API. Respectă limitele cererilor magazinului. Accesul la fiecare operație depinde și de permisiunile planului tău.

Dacă ai nevoie să alegi o limbă sau o piață pentru cereri, obține contextul magazinului. Vei primi limbile și piețele disponibile, împreună cu codurile și identificatorii lor.

Revocă tokenul

Revocarea tokenului este opțională. Dacă îl folosești pentru o singură sarcină, recomandăm să îl revoci la final. Fără revocare manuală, tokenul rămâne valabil până la sfârșitul duratei stabilite. După aceea nu mai poate fi folosit.

POST/api/v1/auth/revoke

Cerere cURL 

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

Răspuns 

{
  "data": {
    "revoked": true
  },
  "meta": {
    "request_id": "example-request"
  }
}