Vai al contenuto
ShopentlyLearn
Italiano

Autenticazione

Crea una chiave API

Per collegare la tua applicazione al negozio ti serve una chiave API. Nel pannello di amministrazione, scegli i permessi per stabilire quali dati l’applicazione può leggere e cosa può modificare nel negozio.

Puoi anche indicare gli indirizzi IP da cui l’applicazione accederà all’API. Se li inserisci, la chiave potrà essere utilizzata solo da quegli indirizzi. Crea quindi la chiave API.

Ottieni un token di accesso

Un token di accesso permette di inviare richieste senza includere la chiave API in ogni richiesta. Puoi revocarlo quando non ti serve più.

Insieme al token riceverai le autorizzazioni e i limiti delle richieste API del tuo negozio.

POST/api/v1/auth/token

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

Risposta 

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

Invia richieste API

Usa il token ricevuto quando invii richieste API. Rispetta i limiti delle richieste del negozio. L’accesso alle singole operazioni dipende anche dalle autorizzazioni del tuo piano.

Se devi scegliere una lingua o un mercato per le richieste, recupera il contesto del negozio. Riceverai le lingue e i mercati disponibili con i rispettivi codici e identificatori.

Revoca il token

Revocare il token è facoltativo. Se lo usi per una singola attività, ti consigliamo di revocarlo al termine. Senza revoca manuale, il token resterà valido fino alla scadenza impostata. Dopo non sarà più utilizzabile.

POST/api/v1/auth/revoke

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

Risposta 

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