Autenticazione con l'API

Riferimento API completo: developer.universally.com contiene la specifica live sia per la Translator API che per la Platform API, con ogni campo, codice di stato ed esempio di risposta. Questa pagina copre ciò che vale la pena sapere al riguardo.

Ogni richiesta API di Universally viene autenticata con una chiave API passata nell'intestazione HTTP X-API-Key.

X-API-Key: your_api_key_here

Due tipi di chiave

Non sono intercambiabili e l'invio di quella errata restituisce API_KEY_INVALID. Quale ti serve dipende dal servizio che stai chiamando.

La traduzione dei contenuti utilizza la chiave di progetto. La gestione di progetti, lingue e stringhe memorizzate dal proprio strumento utilizza una chiave API della piattaforma.

Ottenere una chiave di progetto

Una chiave di progetto viene generata automaticamente quando crei un progetto. Apri il progetto e vai su Impostazioni API per visualizzarla, copiarla o rigenerarla. La visualizzazione richiede il permesso delle chiavi API. Non esiste un endpoint per coniarne una.

Rigenerare la chiave invalida immediatamente quella precedente. Qualsiasi integrazione che utilizza la vecchia chiave inizierà a ricevere API_KEY_INVALID finché non la aggiornerai.

Ottenere una chiave API della piattaforma

Apri l'area di lavoro e vai su Chiavi API, quindi creane una. Vedi Trova la tua chiave API per i campi, inclusa la scadenza e l'elenco dei permessi, e nota che la chiave viene mostrata una sola volta e non può essere recuperata in seguito.

Mantenere la tua chiave al sicuro

La tua chiave può spendere le parole tradotte del tuo piano, quindi trattala come una password:

• Invia richieste da un server, una funzione edge o un job backend. Non incorporare mai la chiave in JavaScript del browser, pacchetti di app mobili o qualsiasi client che un utente possa ispezionare.
• Tieni la chiave fuori dal controllo di versione. Caricala da una variabile d'ambiente o da un gestore di segreti.
• Se un client (un browser o un'app) necessita di contenuti tradotti, instrada la richiesta tramite il tuo backend in modo che la chiave rimanga lato server.

Poiché il Translator consente richieste cross-origin, una chiave compromessa potrebbe essere utilizzata da qualsiasi luogo. Se sospetti che la tua chiave sia esposta, rigenerala nella dashboard.

Verifica di una chiave

Per verificare che una chiave sia valida e vedere a quale sito appartiene, chiama l'endpoint di verifica sul servizio API:

curl https://api.universally.com/connect/keys/verify \
  -H "X-API-Key: your_api_key_here"

{
  "success": true,
  "data": {
    "valid": true,
    "siteId": "site_123",
    "domain": "example.com"
  },
  "message": "API key is valid.",
  "code": "KEY_VALID"
}

Questo è utile durante la configurazione per confermare che un'integrazione sia collegata al sito corretto prima di inviare contenuti reali.

Errori di autenticazione

Vedi Errori e Limiti per la tabella completa.