Contenido de la documentación

/ Empezar

Autenticación

Cómo autenticar cada petición con X-Api-Key y X-Api-Secret, y cómo regenerar tus credenciales.

Credenciales

Cada empresa tiene dos credenciales que se envían como cabeceras HTTP en todas las peticiones:

X-Api-KeystringObligatorio
Identificador de tu empresa. Puedes verlo en el panel cuando quieras.
X-Api-SecretstringObligatorio
Contraseña secreta. Se muestra una sola vez al crear o regenerar las credenciales.

El api_secret se guarda como hash: nadie, ni nosotros, puede recuperarlo. Si lo pierdes, regenera las credenciales; las anteriores quedan inválidas.

Usa las credenciales solo desde tu servidor. Nunca las pongas en código que se ejecute en el navegador o en una app móvil.

curl "https://apifact.gavi-cloud.com/api/v1/empresa" \
  -H "X-Api-Key: TU_API_KEY" \
  -H "X-Api-Secret: TU_API_SECRET"
Respuesta200 OK
{
  "estado": "exito",
  "datos": {
    "ruc": "20100000001",
    "razon_social": "MI EMPRESA SAC",
    "entorno": "beta",
    "is_active": true
  }
}

Regenerar credenciales

POST/empresa/credenciales/regenerar

Genera un api_key y un api_secret nuevos. Las credenciales anteriores dejan de funcionar de inmediato, así que actualiza tus sistemas apenas las recibas.

Con GET /empresa/credenciales puedes ver tu api_key actual; el secret siempre aparece oculto.

curl -X POST "https://apifact.gavi-cloud.com/api/v1/empresa/credenciales/regenerar" \
  -H "X-Api-Key: TU_API_KEY" \
  -H "X-Api-Secret: TU_API_SECRET"

Errores de autenticación

CódigoCausa
401Falta alguna cabecera o las credenciales no son válidas.
403Tu plan no incluye la función solicitada, tu suscripción venció o la empresa está inactiva.