Ir al contenido

Autenticar una solicitud a la API

Envía una clave de API de Threetone en la cabecera x-api-key y mantén la credencial fuera del código del cliente.

Actualizado el

Envía la cabecera de la clave de API

La API pública para uso programático está en https://api.threetone.in. Envía la clave en la cabecera x-api-key de la solicitud:

curl --request GET \
  --url 'https://api.threetone.in/v1/convai/agents' \
  --header "x-api-key: $THREETONE_API_KEY"

Usa la clave como valor de la cabecera. No la incluyas en una URL, cadena de consulta ni cuerpo de la solicitud. Las solicitudes programáticas deben enviar x-api-key. Si la envías junto a una cabecera Authorization, la API rechaza la solicitud por ambigüedad.

Conserva la clave en el servidor

Carga la clave desde un gestor de secretos del servidor o una variable de entorno. No la incluyas en JavaScript del frontend, paquetes de aplicaciones móviles, registros ni mensajes de error. Usa una clave distinta y con permisos limitados para cada integración desplegada, de modo que una filtración no exponga operaciones ajenas.

Registra el ID de la solicitud

Threetone devuelve la cabecera de respuesta X-Request-Id. Al investigar un problema, conserva ese valor junto con la fecha y hora, el método, la ruta y el estado de la solicitud. También puedes enviar tu propio X-Request-Id válido; la API lo devolverá en la respuesta.

Artículos relacionados