API Keys

Cómo usar claves de API con General Translation

Descripción general

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

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

El comportamiento de estos dos tipos de claves es diferente, así que asegúrate de usar la clave correcta para el entorno en el que estés trabajando.

GT_PROJECT_ID=your-project-id
GT_API_KEY=your-api-key

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


Cómo obtenerla

Ve al panel 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 claves de API de Dev para prototipar traducciones y claves de API 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 almacenan temporalmente en memoria. Las traducciones no se guardarán.

La clave de API de desarrollo la utilizan los componentes renderizados en el navegador (client-side) y los 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 pasarse al cliente en un entorno de producción.

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

Advertencia: Las claves de API de desarrollo se pasan al cliente para facilitar la traducción en el cliente durante el desarrollo. Esto es aceptable en entornos de desarrollo, pero supone un riesgo de seguridad en producción. Si tu aplicación es accesible desde internet, nunca debes usar una clave de API de desarrollo.

Clave de API de producción

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

Esta clave se utiliza en dos lugares:

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

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

GT_PROJECT_ID=your-project-id
GT_API_KEY=your-prod-api-key # Esta clave nunca debe exportarse al cliente

Notas

  • Las claves de API de desarrollo se utilizan para pruebas y desarrollo. Deben usarse únicamente en entornos de desarrollo.
  • Las claves de API de producción se utilizan 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 ha parecido esta guía?

API Keys