Aperçu de l'API NN Agent
L'API NN Agent donne à votre produit ce que le tableau de bord donne au gestionnaire : connexion des comptes de messagerie, campagnes, contacts et correspondance. La gestion reste dans votre interface.
Adresse de base : https://api.nexifyneo.com
Ce qui est disponible via l'API#
| Groupe | Ce que cela fait | Page |
|---|---|---|
| Client et licences | Données de compte, activation et renouvellement des licences | Ci-dessous sur cette page |
| Comptes et sessions d'autorisation | Connexion et déconnexion des comptes de messagerie | Comptes |
| Campagnes, contacts, pool de messages | Assemblage de la campagne sortante | Campagnes et contacts |
| Dialogues | Lecture des conversations et envoi de messages | Dialogues |
| Parseur | Collecte des participants et vérification des entités | Parseur |
Au total, la spécification publiée déclare 96 opérations : 35 dans la version v2, 60 dans la version v1 et une vérification d'état de service.
Versions v1 et v2#
v2 — version actuelle. Elle est construite selon le schéma de ressources : entité dans le chemin, action dans la méthode HTTP. v1 est restée de la génération précédente, où l'action était intégrée dans le chemin.
| Tâche | v1 | v2 |
|---|---|---|
| Liste des campagnes | GET /v1/campaign_list/{client_id} |
GET /v2/campaigns |
| Créer une campagne | POST /v1/create_campaign |
POST /v2/campaigns |
| Mettre à jour une campagne | POST /v1/update_campaign |
POST /v2/campaigns/{campaign_id}/update |
| Supprimer une campagne | DELETE /v1/campaign |
DELETE /v2/campaigns/{campaign_id} |
| Envoyer un message | POST /v1/accounts/{account_id}/dialogs/send |
POST /v2/accounts/{account_id}/dialogs/{peer_user_id}/messages |
| Télécharger des contacts | POST /v1/contacts/upload/csv et /excel |
POST /v2/campaigns/{campaign_id}/contacts/upload?format=csv|xlsx |
La principale différence en pratique : dans v2 l'identifiant du client n'est pas transmis dans le chemin — il est déterminé par le token. Dans v1 de nombreuses opérations nécessitent client_id comme paramètre explicite.
Commencez par v2. Contactez v1 si vous avez déjà une intégration fonctionnelle ou si vous avez besoin d'un parseur : il est publié uniquement dans v1. La liste complète — Référence v1.
Vérification de l'accessibilité#
/healthVérification de l'état du service. Aucune autorisation requise.
Envoyé en tant qu'en-tête d'autorisation. Votre clé est utilisée uniquement par votre navigateur pour cette requête — elle n'est jamais envoyée à Docsbook ni stockée.
{ "status": "ok" }Client et licences#
/v2/clientDonnées du compte auquel le jeton est lié.
Envoyé en tant qu'en-tête Authorization. Votre clé est utilisée uniquement par votre navigateur pour cette requête — elle n'est jamais envoyée à Docsbook ni stockée.
/v2/client/licensesListe des licences du client : emplacements actifs et durées.
Envoyé en tant qu'en-tête Authorization. Votre clé est utilisée uniquement par votre navigateur pour cette requête — elle n'est jamais envoyée à Docsbook ni stockée.
/v2/client/licenses/activateActiver la licence par code. Le corps de la requête est en JSON.
Envoyé en tant qu'en-tête Authorization. Votre clé est utilisée uniquement par votre navigateur pour cette requête — elle n'est jamais envoyée à Docsbook ni stockée.
/v2/client/licenses/renewRenouveler une licence active. Le corps de la requête est en JSON.
Envoyé en tant qu'en-tête Authorization. Votre clé est utilisée uniquement par votre navigateur pour cette requête — elle n'est jamais envoyée à Docsbook ni stockée.
/v2/client/telegram-profilesLier un profil Telegram au compte. Le corps de la requête est en JSON.
Envoyé en tant qu'en-tête Authorization. Votre clé est utilisée uniquement par votre navigateur pour cette requête — elle n'est jamais envoyée à Docsbook ni stockée.
/v2/client/telegram-profiles/{tg_id}Détacher le profil Telegram.
Envoyé en tant qu'en-tête d'autorisation. Votre clé est utilisée uniquement par votre navigateur pour cette demande — elle n'est jamais envoyée à Docsbook ni stockée.
Identifiant du profil Telegram
Limitations connues#
Le certificat TLS de l'hôte api.nexifyneo.com est auto-signé. Le navigateur et la plupart des clients HTTP rejettent par défaut la connexion avec une erreur de vérification du certificat. Tant que le certificat n'est pas remplacé par un certificat délivré par une autorité de certification publique, les requêtes interactives depuis la page et les appels de clients stricts ne passeront pas. Vérifiez le statut actuel auprès des gestionnaires dans le bot @NN_official_bot.
Les corps des requêtes ne sont pas typés dans la spécification. Le document OpenAPI publié décrit les corps des requêtes POST comme un objet JSON libre, sans liste de champs. Les pages du guide indiquent ce que la spécification déclare réellement : méthode, chemin, paramètres de chemin et de requête. Pour la composition exacte du corps, vérifiez auprès des gestionnaires dans le bot.
Suite#
- Authentification — comment transmettre le token.
- Erreurs — format de réponse en cas de refus et comment se référer à une requête spécifique.
- Lancer la première campagne via l'API — scénario complet.