API keys

Una API key identifica tu integración ante la API. Pertenece a un espacio de trabajo y tiene los permisos que tú eliges.

Crear una clave En el panel

1. Verifica tu correo. Mientras no esté verificado, el panel no deja crear claves API.
2. Abre Claves API y elige Crear clave API.
3. Escribe un nombre que te diga para qué se usa (por ejemplo, Producción o Integración de pedidos).
4. Marca los permisos que necesita. Los permisos disponibles están en Autenticación.
5. Elige Crear clave y copia el valor con Copiar.

Se muestra una sola vez

Esta clave solo se mostrará una vez. Si la pierdes, revócala y crea una nueva. ZAPPIO no puede volver a mostrártela.

Las claves empiezan con zp_ y en esta documentación aparecen como zp_.... Las claves que se crearon antes del cambio de marca (empiezan con nx_) siguen funcionando.

Usarla

Envíala en el header Authorization de cada petición:

curl "https://zappio.cloud/api/v1/api-key" \
  -H "Authorization: Bearer $ZAPPIO_API_KEY"

Elegir permisos

Da a cada clave solo lo que necesita:

Tu integración…	Scopes típicos
Solo envía mensajes	messages:send, instances:read
Envía y consulta el estado de los mensajes	messages:send, messages:read, instances:read
Administra webhooks	webhooks:read, webhooks:write
Crea y conecta instancias	instances:read, instances:write

Revocar y rotar En el panel

Desde Claves API puedes Revocar una clave. Una clave revocada responde 401 INVALID_API_KEY de inmediato.

Para rotar una clave sin cortes: crea una nueva, despliégala en tu aplicación y revoca la anterior cuando ya no se use.

Seguridad

• Trata la clave como una contraseña: variable de entorno o gestor de secretos.
• No la pongas en código que corre en el navegador ni en aplicaciones móviles: cualquiera podría extraerla.
• No la incluyas en repositorios, tickets ni capturas de pantalla.
• Una clave por entorno o integración facilita revocar solo la que se filtró.