Autenticación | API VERTEX ERP

API Keys

La API de Vertex usa API Keys para autenticar requests. Cada key está asociada a un tenant (organización) y tiene permisos específicos (scopes).

Cómo usar tu API Key

Incluye la key en el header Authorization de cada request: ``

bash
curl -X GET https://vertex.app/api/v1/invoices \
  -H "Authorization: Bearer vtx_tu_api_key_aqui"



Formato de la key

Las API keys de Vertex tienen el formato:

vtx_

 seguido de 40 caracteres hexadecimales.

Ejemplo:

vtx_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2



Scopes (permisos)

Cada key puede tener uno o más scopes que determinan qué operaciones puede realizar:

Scope Descripción
invoices:read Consultar facturas y sus detalles
invoices:write Crear y modificar facturas
invoices:void Anular facturas y generar notas de crédito
Seguridad

Nunca expongas tu API key en código frontend o repositorios públicos
Usa variables de entorno para almacenar las keys
Cada key está asociada a un solo tenant
Las keys revocadas dejan de funcionar inmediatamente
Puedes restringir keys a IPs específicas desde la configuración

Errores de autenticación

Status Código Significado
401 UNAUTHORIZED Key no proporcionada o inválida
401 KEY_EXPIRED La key ha expirado
403 INSUFFICIENT_SCOPE La key no tiene el scope requerido
403 IP_NOT_ALLOWED` Request desde IP no permitida

Scope	Descripción
invoices:read	Consultar facturas y sus detalles
invoices:write	Crear y modificar facturas
invoices:void	Anular facturas y generar notas de crédito

Status	Código	Significado
401	UNAUTHORIZED	Key no proporcionada o inválida
401	KEY_EXPIRED	La key ha expirado
403	INSUFFICIENT_SCOPE	La key no tiene el scope requerido
403	IP_NOT_ALLOWED`	Request desde IP no permitida