Autentícate con la API

Referencia completa de la API: developer.universally.com contiene la especificación en vivo tanto para la API del Traductor como para la API de Plataforma, con cada campo, código de estado y ejemplo de respuesta. Esta página cubre lo que vale la pena saber al respecto.

Cada solicitud a la API de Universally se autentica con una clave de API que se pasa en la cabecera HTTP X-API-Key.

X-API-Key: your_api_key_here

Dos tipos de clave

No son intercambiables y enviar la incorrecta devuelve API_KEY_INVALID. Cuál necesitas depende del servicio al que te estés conectando.

La traducción de contenido utiliza la clave del proyecto. La gestión de proyectos, idiomas y cadenas almacenadas desde tus propias herramientas utiliza una clave de API de plataforma.

Obtener una clave de proyecto

Una clave de proyecto se genera automáticamente cuando creas un proyecto. Abre el proyecto y ve a Configuración de la API para verla, copiarla o regenerarla. Verla requiere el permiso de claves de API. No hay un punto de conexión para acuñar una.

Regenerar la clave invalida inmediatamente la anterior. Cualquier integración que utilice la clave antigua comenzará a recibir API_KEY_INVALID hasta que la actualices.

Obtener una clave de API de plataforma

Abre el espacio de trabajo y ve a Claves de API, luego crea una. Consulta Encuentra tu clave de API para ver los campos, incluida la fecha de caducidad y la lista de permisos, y ten en cuenta que la clave se muestra una vez y no se puede recuperar después.

Mantener tu clave segura

Tu clave puede consumir las palabras traducidas de tu plan, así que trátala como una contraseña:

• Envía solicitudes desde un servidor, una función de borde o un trabajo de backend. Nunca incrustes la clave en JavaScript del navegador, paquetes de aplicaciones móviles o cualquier cliente que un usuario pueda inspeccionar.
• Mantén la clave fuera del control de versiones. Cárgala desde una variable de entorno o un gestor de secretos.
• Si un cliente (un navegador o una aplicación) necesita contenido traducido, enruta la solicitud a través de tu propio backend para que la clave permanezca en el lado del servidor.

Debido a que el Traductor permite solicitudes de origen cruzado, una clave filtrada podría usarse desde cualquier lugar. Si sospechas que tu clave está expuesta, regenérala en el panel de control.

Verificar una clave

Para comprobar que una clave es válida y ver a qué sitio pertenece, llama al punto de conexión de verificación en el servicio de 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"
}

Esto es útil durante la configuración para confirmar que una integración está conectada al sitio correcto antes de enviar contenido real.

Errores de autenticación

Consulta Errores y Límites para ver la tabla completa.