Claves API

Descripción general

Hay dos tipos de claves API utilizadas con General Translation:

Clave API de Producción: Se utiliza para traducir tu contenido en producción.
Clave API de Desarrollo: Se utiliza para traducir tu contenido en desarrollo.

El comportamiento entre los dos tipos de claves es diferente, por lo que debes tener cuidado de usar la clave correcta para el entorno en el que te encuentras.

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

Si estás utilizando gt-next o gt-react como una biblioteca i18n independiente, no necesitas usar claves API.

Cómo obtenerlas

Navega al panel de control 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 API y pégala en el archivo .env de tu proyecto.

En términos simples, las claves API de Producción persisten las traducciones, mientras que las claves API de Desarrollo no lo hacen. Utilizas las claves API de Desarrollo para prototipar traducciones y las claves API de Producción cuando estás listo para implementar.

Clave API de Desarrollo

Este tipo de clave es útil para propósitos de prueba y desarrollo. Cuando se utiliza una clave API de desarrollo, las traducciones se realizan bajo demanda y se memorizan en la memoria. Las traducciones no se guardarán.

La clave API de desarrollo es utilizada por componentes renderizados en el navegador (del lado del cliente) y por componentes renderizados del lado del servidor para facilitar la traducción bajo demanda. Esto significa que debe ser exportada al cliente. Esta clave NUNCA debe ser utilizada en entornos de producción y NUNCA debe ser pasada 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 usa en desarrollo

Advertencia: Las claves API de desarrollo se pasan al cliente para facilitar la traducción del lado del cliente en desarrollo. Esto está bien en entornos de desarrollo, pero es un riesgo de seguridad en entornos de producción. Si tu aplicación está abierta a internet, nunca deberías usar una clave API de desarrollo.

Clave API de Producción

Cuando se utiliza una clave API de producción, las traducciones son persistentes. Esto significa que las traducciones se guardarán (ya sea en un CDN o en el paquete de tu aplicación) para ser utilizadas en tiempo de ejecución.

Esta clave se utiliza en dos lugares:

La herramienta gtx-cli. Consulta esta guía para más información.
La biblioteca gt-next cuando las traducciones ocurren en tiempo de ejecución en una compilación de producción (solo del lado del servidor, no utilizada por gt-react).
- Las funciones <Tx> y tx() se utilizan para traducir contenido en tiempo de ejecución.

La clave API solo es utilizada por el servidor, y NUNCA debe ser exportada al cliente.

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

Notas

Las claves API de desarrollo se utilizan para pruebas y propósitos de desarrollo. Solo deben utilizarse en desarrollo.
Las claves API de producción se utilizan para propósitos de producción.

Próximos pasos

Consulta cómo usar el componente <T> para ver traducciones en vivo en desarrollo.
Consulta la guía de uso para la herramienta cli.