Resumen de la API NN Agent
La API NN Agent le proporciona a su producto lo mismo que un panel le da a un gerente: conexión de cuentas de mensajería, campañas, contactos y correspondencia. La gestión permanece en su interfaz.
Dirección base: https://api.nexifyneo.com
Qué está disponible a través de la API#
| Grupo | Qué hace | Página |
|---|---|---|
| Cliente y licencias | Datos de la cuenta, activación y renovación de licencias | Más abajo en esta página |
| Cuentas y sesiones de autorización | Conexión y desconexión de cuentas de mensajería | Cuentas |
| Campañas, contactos, grupo de mensajes | Construcción de una campaña saliente | Campañas y contactos |
| Diálogos | Lectura de conversaciones y envío de mensajes | Diálogos |
| Parser | Recolección de participantes y verificación de entidades | Parser |
En total, la especificación publicada declara 96 operaciones: 35 en la versión v2, 60 en la versión v1 y una verificación de estado de servicio.
Versiones v1 y v2#
v2 — la versión actual. Se basa en un esquema de recursos: entidad en la ruta, acción en el método HTTP. v1 se ha mantenido de la generación anterior, donde la acción se trasladó a la ruta.
| Tarea | v1 | v2 |
|---|---|---|
| Lista de campañas | GET /v1/campaign_list/{client_id} |
GET /v2/campaigns |
| Crear campaña | POST /v1/create_campaign |
POST /v2/campaigns |
| Actualizar campaña | POST /v1/update_campaign |
POST /v2/campaigns/{campaign_id}/update |
| Eliminar campaña | DELETE /v1/campaign |
DELETE /v2/campaigns/{campaign_id} |
| Enviar mensaje | POST /v1/accounts/{account_id}/dialogs/send |
POST /v2/accounts/{account_id}/dialogs/{peer_user_id}/messages |
| Cargar contactos | POST /v1/contacts/upload/csv y /excel |
POST /v2/campaigns/{campaign_id}/contacts/upload?format=csv|xlsx |
La principal diferencia en la práctica: en v2 el identificador del cliente no se pasa en la ruta — lo determina el token. En v1 muchas operaciones requieren client_id como parámetro explícito.
Comience con v2. Dirígete a v1 si ya tienes una integración funcional o necesitas un parser: está publicado solo en v1. La lista completa es Referencia v1.
Comprobación de disponibilidad#
/healthComprobación del estado del servicio. No se requiere autorización.
Enviado como el encabezado de autorización. Tu clave es utilizada solo por tu navegador para esta solicitud — nunca se envía a Docsbook ni se almacena.
{ "status": "ok" }Cliente y licencias#
/v2/clientDatos de la cuenta a la que está vinculado el token.
Enviado como el encabezado de autorización. Su clave es utilizada solo por su navegador para esta solicitud — nunca se envía a Docsbook ni se almacena.
/v2/client/licensesLista de licencias del cliente: slots activos y plazos.
Enviado como el encabezado de autorización. Su clave es utilizada solo por su navegador para esta solicitud — nunca se envía a Docsbook ni se almacena.
/v2/client/licenses/activateActivar licencia por código. El cuerpo de la solicitud es JSON.
Enviado como el encabezado de autorización. Su clave es utilizada solo por su navegador para esta solicitud — nunca se envía a Docsbook ni se almacena.
/v2/client/licenses/renewRenovar licencia activa. El cuerpo de la solicitud es JSON.
Enviado como el encabezado de autorización. Su clave es utilizada solo por su navegador para esta solicitud — nunca se envía a Docsbook ni se almacena.
/v2/client/telegram-profilesVincular perfil de Telegram a la cuenta. El cuerpo de la solicitud es JSON.
Enviado como el encabezado de autorización. Su clave es utilizada solo por su navegador para esta solicitud — nunca se envía a Docsbook ni se almacena.
/v2/client/telegram-profiles/{tg_id}Desvincular perfil de Telegram.
Enviado como el encabezado de Autorización. Tu clave es utilizada solo por tu navegador para esta solicitud — nunca se envía a Docsbook ni se almacena.
Identificador del perfil de Telegram
Conocidos límites#
El certificado TLS del host api.nexifyneo.com es autofirmado. El navegador y la mayoría de los clientes HTTP rechazan la conexión por defecto con un error de verificación del certificado. Hasta que el certificado sea reemplazado por uno emitido por una autoridad de certificación pública, las solicitudes interactivas desde la página y las llamadas desde clientes estrictos no pasarán. Aclare el estado actual con los gerentes en el bot @NN_official_bot.
Los cuerpos de las solicitudes no están tipificados en la especificación. El documento OpenAPI publicado describe los cuerpos de las solicitudes POST como un objeto JSON libre, sin un listado de campos. En las páginas del manual se indica lo que la especificación realmente declara: método, ruta, parámetros de ruta y de solicitud. Aclare la composición exacta del cuerpo con los gerentes en el bot.
Siguiente#
- Autenticación — cómo transmitir el token.
- Errores — formato de respuesta en caso de fallo y cómo referirse a una solicitud específica.
- Iniciar la primera campaña a través de la API — escenario completo.