Autenticación
Cada solicitud a la API usa un token Bearer creado en su espacio de trabajo.
Vergora usa claves de API para autenticar las solicitudes. Envíelas desde una aplicación del servidor y pase la credencial en la cabecera
Authorization.
Cabecera de solicitud
Authorization: Bearer YOUR_VERGORA_API_KEYMantenga un espacio entre Bearer y la clave. No incluya una clave de API en un parámetro de consulta de la URL.
Cree una clave de API
- Inicie sesión en la consola y abra Claves de API.
- Cree una nueva clave de API.
- Use un nombre que identifique la aplicación y el entorno, como
storefront-production. - Configure su presupuesto, caducidad y acceso a modelos para la aplicación.
- Siga las instrucciones de la página para copiar y guardar de forma segura la clave completa.
Guía de configuración
| Configuración | Orientación |
|---|---|
| Nombre | Incluya la aplicación y el entorno |
| Entorno | Use claves distintas para desarrollo, pruebas y producción |
| Presupuesto | Ajústelo al uso esperado; el presupuesto de una clave no añade fondos al saldo |
| Caducidad | Use plazos cortos para pruebas temporales y revise periódicamente las claves de producción |
| Acceso a modelos | Permita solo los modelos que necesite la aplicación |
| Restricciones de origen | Si están activadas, use la dirección real de salida de la aplicación |
Use la clave en una aplicación
export VERGORA_API_KEY="YOUR_VERGORA_API_KEY"Lea el valor desde una variable de entorno del servidor o un gestor de secretos. Nunca exponga una clave completa en código fuente, scripts del navegador, repositorios públicos, registros ni capturas de pantalla.
Rote una clave o deje de usarla
- Cree una clave de reemplazo.
- Actualice la aplicación y envíe una solicitud mínima.
- Confirme la nueva solicitud en Registros de API.
- Deje de usar la clave anterior.
- Compruebe que ninguna aplicación siga usando la credencial anterior.
Si pierde la clave completa, cree una de reemplazo mediante el proceso de la consola. Si sospecha una exposición, deje de usar inmediatamente la credencial afectada y revise sus registros de solicitudes.
Diagnóstico de autenticación
| Comprobación | Acción recomendada |
|---|---|
| La clave está vacía o incompleta | Vuelva a cargar la variable de entorno del servidor |
| La cabecera no es válida | Use Authorization: Bearer <key> |
| La clave ha caducado o está inactiva | Compruebe su estado y cree una de reemplazo |
| El presupuesto o el ámbito de modelos bloquean la solicitud | Revise la política de la clave y el modelo seleccionado |
| El origen no está permitido | Confirme la dirección real de salida de la aplicación |
Para una primera integración, complete primero el Inicio rápido.