Claves de API

Cómo usar las claves de API con General Translation

Descripción general

Hay dos tipos de claves de API que se utilizan con General Translation:

  • Clave de API de producción: se usa para traducir tu contenido en producción.
  • Clave de API de desarrollo: se usa para traducir tu contenido en desarrollo.

El comportamiento de ambos tipos de claves es distinto, así que asegúrate de usar la clave correcta para el entorno en el que te encuentras.

GT_PROJECT_ID=tu-id-de-proyecto
GT_API_KEY=tu-clave-de-API

Si usas gt-next o gt-react como una biblioteca de i18n independiente, no necesitas claves de API.


Cómo obtenerla

Ve al dashboard de tu proyecto en el sitio web de General Translation.

Haz clic en la pestaña «API Keys» o «Developer Keys».

Haz clic en el botón «Create API Key».

Copia la clave de API y pégala en el archivo .env de tu proyecto.


Comportamiento

En pocas palabras, las claves de API de Prod conservan las traducciones, mientras que las claves de API de Dev no. Usa las claves de API de Dev para crear prototipos de traducciones y las de Prod cuando estés listo para implementar.

Clave de API de desarrollo

Este tipo de clave es útil para pruebas y desarrollo. Cuando se utiliza una clave de API de desarrollo, las traducciones se realizan a demanda y se memorizan en memoria. Las traducciones no se guardarán.

La clave de API de desarrollo es utilizada por componentes renderizados en el navegador (client-side) y por componentes renderizados en el servidor (server-side) para facilitar la traducción a demanda. Esto significa que debe exportarse al cliente. Esta clave NUNCA debe usarse en entornos de producción y NUNCA debe enviarse al cliente en un entorno de producción.

# ejemplo de archivo .env de Vite para desarrollo
VITE_GT_PROJECT_ID=your-project-id
VITE_GT_API_KEY=your-dev-api-key # Solo se utiliza en desarrollo

Advertencia: Las claves de API de desarrollo se envían al cliente para facilitar la traducción del lado del cliente durante el desarrollo. Esto es aceptable en entornos de desarrollo, pero supone un riesgo de seguridad en entornos de producción. Si tu aplicación está expuesta a Internet, nunca debes usar una clave de API de desarrollo.

Clave de API de producción

Cuando se usa una clave de API de producción, las traducciones se persisten. Esto significa que las traducciones se guardarán (ya sea en una red de distribución de contenido, CDN, o en el bundle de tu app) para usarse en tiempo de ejecución.

Esta clave se utiliza en dos lugares:

  • La herramienta gtx-cli. Consulta la documentación para más información.
  • La biblioteca gt-next cuando las traducciones se realizan en tiempo de ejecución en un build de producción (solo del lado del servidor; no se usa con gt-react).
    • Las funciones <Tx> y tx se usan para traducir contenido en tiempo de ejecución.

La clave de API solo la usa el servidor y NUNCA debe exportarse al cliente.

GT_PROJECT_ID=tu-id-de-proyecto
GT_API_KEY=tu-api-key-de-producción # Esta clave nunca debe exportarse al cliente

Notas

  • Las claves de API de desarrollo se usan para pruebas y desarrollo. Deben usarse solo en entornos de desarrollo.
  • Las claves de API de producción se usan para entornos de producción.

Próximos pasos

  • Descubre cómo usar el componente <T> para ver traducciones en tiempo real durante el desarrollo.

¿Qué te parece esta guía?