AllyOneCRM / Quickstart

Quickstart

De una cuenta vacía al primer contacto registrado, en 3 llamadas.

1

Crea la cuenta

POST/v1/auth/register
{
  "tenantName": "Mi Empresa",
  "name": "Tu Nombre",
  "email": "tu@empresa.com",
  "password": "..."
}

Guarda el accessToken de la respuesta — o crea una API Key apenas tengas un tenant, si prefieres integrar desde un backend en lugar de una sesión de usuario.

2

Registra tu primer contacto

POST/v1/contacts
curl -X POST https://api.allyone.com.br/v1/contacts \
  -H "Authorization: Bearer eyJhbGci..." \
  -H "Content-Type: application/json" \
  -d '{
    "firstName": "María",
    "phone": "+5511999998888",
    "optInWhatsapp": true
  }'

email o phone — al menos uno de los dos es obligatorio.

3

Conecta un canal y habla con ese contacto

Las integraciones envían mensajes por uno de los tres motores de automatización o por una campaña, siempre asociados a un canal conectado. (Responder dentro de una conversación abierta, como hace un agente en la bandeja, usa POST /v1/chat/conversations/:id/messages con sesión de usuario.) El camino más corto hasta un mensaje real:

  1. Conecta un número de WhatsApp mediante Embedded Signup.
  2. Crea un Chat Flow simple, o dispara una campaña manual al contacto que acabas de crear.
Listo

Tienes una cuenta, un contacto y sabes dónde conectar el primer canal. Próximo paso natural: Conectar WhatsApp.

OpenAPI y Postman

La superficie de integración del CRM (autenticación, claves de API, contactos, listas, segmentos, campañas, formularios, ventas, conversaciones, WhatsApp y webhooks) está descrita en OpenAPI 3.1 y en una colección de Postman. Impórtala en Postman, Insomnia o en el generador de SDK que prefieras.

Las rutas fuera de la especificación son internas y pueden cambiar sin aviso. Una prueba automatizada compara la especificación con el código en cada cambio, así que no se queda atrás.

Quickstart — AllyOneCRM