Prima chiamata: identità

Prima di creare ordini o consultare il catalogo, conviene fare una chiamata di prova molto semplice: serve a verificare che la tua API key funzioni e che l'autenticazione sia impostata correttamente.

Questa chiamata si chiama "identità" e risponde a una domanda di base: "chi sono io agli occhi dell'API Sterna?".

A cosa serve

La chiamata di identità non crea nulla e non consuma plafond: si limita a restituire le informazioni sul tuo account e sulla chiave che stai usando. È il modo più rapido per:

• verificare che la tua API key sia valida e attiva;
• sapere se stai usando una chiave di ambiente test o live;
• vedere quali permessi (scopes) ha la tua chiave.

È buona norma fare questa chiamata come primo test dell'integrazione.

L'endpoint

Per ottenere le informazioni di identità si usa questo endpoint:

GET /v1/me

Ricorda che tutti gli indirizzi vanno aggiunti al Base URL: l'indirizzo completo della chiamata è quindi https://api.sterna.mobi/v1/me.

Esempio di richiesta

Ecco la stessa chiamata in tre linguaggi diversi. In tutti, ricordati di sostituire stk_test_51H8d... con la tua API key.

curl https://api.sterna.mobi/v1/me \
  -H "Authorization: Bearer stk_test_51H8d..."

Esempio di risposta

Se l'autenticazione funziona, l'API risponde con un oggetto JSON simile a questo:

{
  "authenticated": true,
  "client": {
    "id": "...",
    "company_name": "La Tua Azienda SRL",
    "status": "active"
  },
  "api_key": {
    "id": "...",
    "environment": "test",
    "scopes": ["read", "write"]
  }
}

Come leggere la risposta

I campi più utili della risposta sono:

• `authenticated` — Vale true se la chiave è valida. È la conferma che l'autenticazione funziona.
• `client` — I dati del tuo account: identificativo, nome dell'azienda e stato.
• `api_key.environment` — Ti dice se la chiave che stai usando è di ambiente test o live.
• `api_key.scopes` — L'elenco dei permessi della chiave: read, write, o entrambi.