Cómo usar la API de Waclis: autenticación, endpoints y ejemplos básicos

La API de Waclis permite a los desarrolladores integrar la plataforma con otros sistemas, automatizar tareas y personalizar flujos de trabajo para satisfacer las necesidades específicas del negocio. A través de la API, es posible acceder a datos de Waclis, como contactos, conversaciones y agentes, o ejecutar acciones específicas, como enviar mensajes y actualizar información.

Autenticación

Para utilizar la API de Waclis, se necesita un token de acceso que autentique las solicitudes enviadas a la plataforma. La autenticación garantiza que solo los usuarios autorizados puedan acceder y modificar los datos de Waclis.

1. Obtener el token de acceso

   • Inicia sesión en tu cuenta de Waclis y dirígete a en la parte inferior inquierda al icono de tu perfil > Ajustes del Perfil

   • En la sección de API, encontrarás la opción token de acceso. Este token es único para cada cuenta y debe mantenerse seguro.

2. Incluir el token en las solicitudes

   • Agrega el token de acceso en los encabezados de cada solicitud API utilizando el formato Authorization: Bearer {token}.

Ejemplo de encabezado:
httpAuthorization: Bearer tu_token_de_acceso

• Todas las solicitudes a la API de Waclis requieren este encabezado para ser autorizadas.

Endpoints básicos de la API

Waclis ofrece una serie de endpoints para gestionar diferentes aspectos de la plataforma. Aquí te mostramos algunos de los endpoints más comunes y ejemplos de cómo utilizarlos:

1. Obtener información de contactos

   • Endpoint: /api/v1/contacts

   • Método: GET

   • Descripción: Recupera la lista de contactos registrados en Waclis.

Ejemplo de solicitud:
http GET /api/v1/contacts

Authorization: Bearer tu_token_de_acceso

Respuesta esperada:
json [

{

"id": 1,

"nombre": "Juan Pérez",

"email": "juan@example.com",

"telefono": "+1 123 456 7890",

"creado_en": "2023-10-01T15:30:00Z"

},

...

]

1. Enviar un mensaje en una conversación

   • Endpoint: /api/v1/conversations/{conversation_id}/messages

   • Método: POST

   • Descripción: Permite enviar un mensaje en una conversación existente.

   • Parámetros:

     • conversation_id: ID de la conversación.

     • contenido: Contenido del mensaje.

Ejemplo de solicitud:
http POST /api/v1/conversations/123/messages

Authorization: Bearer tu_token_de_acceso

Content-Type: application/json

{

"contenido": "Hola, ¿en qué puedo ayudarte?"

}

Respuesta esperada:
json {

"id": 456,

"contenido": "Hola, ¿en qué puedo ayudarte?",

"creado_en": "2023-10-02T08:45:00Z",

"autor": "Agente"

}

1. Actualizar el estado de una conversación

   • Endpoint: /api/v1/conversations/{conversation_id}

   • Método: PATCH

   • Descripción: Permite actualizar el estado de una conversación a “abierta”, “cerrada” o “en espera”.

   • Parámetros:

     • conversation_id: ID de la conversación.

     • estado: Estado deseado de la conversación.

Ejemplo de solicitud:
http PATCH /api/v1/conversations/123

Authorization: Bearer tu_token_de_acceso

Content-Type: application/json

{

"estado": "cerrada"

}

Respuesta esperada:
json {

"id": 123,

"estado": "cerrada",

"actualizado_en": "2023-10-02T09:30:00Z"

}

Ejemplo práctico de uso de la API de Waclis

• Situación: Una empresa de soporte desea crear un sistema automático que envíe un mensaje de bienvenida cada vez que se inicie una conversación.

• Proceso:

  • Configura un webhook para que Waclis envíe una notificación cada vez que se crea una conversación.

  • Utiliza el endpoint de envío de mensajes para enviar un mensaje de bienvenida utilizando el conversation_id proporcionado por el webhook.

  • Ejemplo de flujo:

    1. El webhook notifica la creación de una nueva conversación.

    2. Se realiza una solicitud POST al endpoint /api/v1/conversations/{conversation_id}/messages con el mensaje de bienvenida.

  • Resultado: Cada vez que se inicie una conversación, el sistema envía automáticamente un mensaje de bienvenida.

Consejos para el uso de la API de Waclis

• Asegura la seguridad de tu token: El token de acceso debe ser tratado como confidencial, ya que permite el acceso directo a los datos de Waclis.

• Utiliza webhooks para automatizaciones: Combinando la API de Waclis con webhooks puedes crear flujos de trabajo automáticos y reaccionar a eventos en tiempo real.

• Consulta la documentación para endpoints adicionales: La API de Waclis incluye varios endpoints adicionales para personalizar la experiencia según las necesidades del negocio.

Accede a la documentación del API en AQUI