Autenticazione

Ogni endpoint richiede una API key. La stessa key ti identifica e determina quali endpoint puoi chiamare.

Ottenere una key

Una volta che Syrto ha predisposto un’API per la tua organizzazione, gli amministratori creano e revocano le API key nella dashboard Syrto. Ogni key è associata alla tua organizzazione.

Inviare la tua key

Passa la key come bearer token nell’header Authorization:

Authorization: Bearer sk_...

Le key iniziano con sk_. Tienile segrete - una key dà accesso ai tuoi dati e consuma il tuo utilizzo. Invia ogni richiesta su HTTPS e non inserire mai una key in un URL. Gli esempi in questa documentazione leggono la key da una variabile d’ambiente SYRTO_API_KEY, così puoi esportarla una volta ed eseguire qualsiasi esempio:

export SYRTO_API_KEY=sk_...

curl -s -H "Authorization: Bearer $SYRTO_API_KEY" \
  https://api.syrto.ai/companies/01654010345/financials

Errori di autenticazione

Codice	HTTP	Quando
`missing_api_key`	`401`	Nessun header `Authorization`, oppure non è un bearer token.
`invalid_api_key`	`401`	La key non è riconosciuta.
`auth_unavailable`	`503`	La verifica della key è temporaneamente non disponibile. Riprova dopo una breve attesa - non ruotare la key.

Un 503 auth_unavailable significa che il servizio non è riuscito a verificare la tua key in questo momento, non che la key sia sbagliata. Riprova con backoff; ruotare la key non serve.

Ogni risposta di errore segue l’envelope di errore standard:

{
  "error": {
    "code": "missing_api_key",
    "message": "Missing API key.",
    "requestId": "req_018f9c2e7b7a7c3e9a1b2c3d4e5f6a7b"
  }
}

I tuoi endpoint e la tua specifica

La tua key è limitata agli endpoint inclusi nel tuo piano. Per vedere esattamente quali endpoint e schemi può usare la tua key, scarica la tua specifica OpenAPI - viene generata per ogni key e contiene solo gli endpoint che ti sono offerti.

Per iniziare

Endpoint di esempio

Riferimento interattivo

Riferimento

Autenticazione

Ottenere una key

Inviare la tua key

Errori di autenticazione

I tuoi endpoint e la tua specifica

​Ottenere una key

​Inviare la tua key

​Errori di autenticazione

​I tuoi endpoint e la tua specifica

Ottenere una key

Inviare la tua key

Errori di autenticazione

I tuoi endpoint e la tua specifica