Chiavi API

Come utilizzare le chiavi API con General Translation

Panoramica

Con General Translation si utilizzano due tipi di chiavi API:

  • Chiave API di produzione: usata per tradurre i contenuti nell’ambiente di produzione.
  • Chiave API di sviluppo: usata per tradurre i contenuti nell’ambiente di sviluppo.

Il comportamento dei due tipi di chiavi è diverso, quindi assicurati di usare la chiave corretta per l’ambiente in cui operi.

GT_PROJECT_ID=ID-progetto
GT_API_KEY=chiave-API

Se usi gt-next o gt-react come libreria i18n autonoma, non devi utilizzare le chiavi API.


Come ottenerla

Vai alla dashboard del tuo progetto sul sito di General Translation.

Clicca sulla scheda "API Keys" o "Developer Keys".

Clicca sul pulsante "Create API Key".

Copia la chiave API e incollala nel file .env del tuo progetto.


Comportamento

In parole povere, le chiavi API Prod salvano le traduzioni in modo permanente, mentre le chiavi API Dev no. Usa le chiavi API Dev per creare prototipi di traduzione e le chiavi API Prod quando sei pronto per la distribuzione.

Chiave API di sviluppo

Questo tipo di chiave è utile per test e attività di sviluppo. Quando si utilizza una chiave API di sviluppo, le traduzioni vengono eseguite on demand e memorizzate in memoria. Le traduzioni non verranno salvate.

La chiave API di sviluppo è utilizzata dai componenti renderizzati nel browser (lato client) e da quelli renderizzati lato server per abilitare la traduzione on demand. Ciò significa che deve essere disponibile al client. Questa chiave NON deve MAI essere utilizzata in ambienti di produzione e NON deve MAI essere inviata al client in produzione.

# esempio di file .env di Vite per lo sviluppo
VITE_GT_PROJECT_ID=your-project-id
VITE_GT_API_KEY=your-dev-api-key # Utilizzata solo in fase di sviluppo

Avviso: Le chiavi API di sviluppo vengono inviate al client per abilitare la traduzione lato client durante lo sviluppo. Questo è accettabile negli ambienti di sviluppo, ma costituisce un rischio per la sicurezza in produzione. Se la tua applicazione è accessibile da Internet, non utilizzare mai una chiave API di sviluppo.

Chiave API di produzione

Quando si utilizza una chiave API di produzione, le traduzioni vengono persistite. Questo significa che le traduzioni verranno salvate (su un CDN o nel bundle della tua app) per essere utilizzate a runtime.

Questa chiave viene utilizzata in due contesti:

  • Lo strumento gtx-cli. Consulta la documentazione per ulteriori informazioni.
  • La libreria gt-next quando le traduzioni avvengono a runtime in una build di produzione (solo lato server, non utilizzata da gt-react).
    • Le funzioni <Tx> e tx vengono utilizzate per tradurre i contenuti a runtime.

La chiave API è utilizzata solo dal server e NON deve MAI essere esposta al client.

GT_PROJECT_ID=your-project-id
GT_API_KEY=your-prod-api-key # Questa chiave non deve mai essere esposta al client

Note

  • Le chiavi API di sviluppo sono utilizzate per test e sviluppo. Devono essere usate solo in ambiente di sviluppo.
  • Le chiavi API di produzione sono utilizzate in ambiente di produzione.

Prossimi passaggi

  • Scopri come usare il componente <T> per visualizzare le traduzioni in tempo reale durante lo sviluppo.

Come valuti questa guida?

Chiavi API