Primeros pasos con la API de Synvaxis
La API pública está disponible bajo /api/v1. Permite consultar contactos, conversaciones, mensajes, pedidos, productos y citas, y crear contactos. Usa JSON y autenticación Bearer.
1. Crea una clave
Abre Desarrolladores, entra en Claves API y crea una clave con un nombre reconocible. Elige read para consultas o write si necesitas crear contactos. Guarda el secreto al crearlo: se muestra una sola vez.
La creación de claves y webhooks requiere un plan habilitado. No uses las credenciales de sesión del panel como si fueran una clave de integración.
2. Comprueba la conexión
Guarda la clave en la variable de entorno SYNVAXIS_API_KEY de tu servidor. Este ejemplo de Bash consulta la identidad de la conexión:
curl --fail-with-body "https://app.synvaxis.com/api/v1/_meta" \
-H "Authorization: Bearer $SYNVAXIS_API_KEY"
La respuesta incluye api_version, user_id, scope, key_prefix y un objeto plan. Usa el dominio de tu instalación si es distinto. No escribas la clave dentro de una aplicación pública ni en un repositorio.
3. Consulta un recurso
curl --fail-with-body "https://app.synvaxis.com/api/v1/contacts?limit=10" \
-H "Authorization: Bearer $SYNVAXIS_API_KEY"
Los listados responden con data y next_cursor. Los detalles y la creación de contacto devuelven el objeto directamente. Sigue la paginación hasta que next_cursor sea null.
Qué está disponible
Las consultas GET cubren los recursos de la referencia. La escritura pública implementada es POST /api/v1/contacts. La API de mensajes es de lectura: no hay un POST público para enviar WhatsApp ni crear pedidos o citas.
Herramientas para integrar
Descarga la especificación OpenAPI para importarla en tu cliente de API. Revisa autenticación y límites antes de automatizar consultas y webhooks para recibir los eventos implementados.
Antes de pasar a producción
Prueba con datos autorizados, conserva x-request-id en tus registros, limita los reintentos y rota la clave cuando cambies de entorno o responsable.