Überblick über die NN Agent API
Die NN Agent API bietet Ihrem Produkt das gleiche, was ein Dashboard einem Manager bietet: die Verbindung von Messenger-Konten, Kampagnen, Kontakten und Nachrichten. Die Verwaltung bleibt dabei in Ihrer Benutzeroberfläche.
Basisadresse: https://api.nexifyneo.com
Was über die API verfügbar ist#
| Gruppe | Was es macht | Seite |
|---|---|---|
| Client und Lizenzen | Kontodaten, Aktivierung und Verlängerung von Lizenzen | Unten auf dieser Seite |
| Konten und Autorisierungssitzungen | Verbindung und Trennung von Messenger-Konten | Konten |
| Kampagnen, Kontakte, Nachrichtenpool | Zusammenstellung einer ausgehenden Kampagne | Kampagnen und Kontakte |
| Dialoge | Lesen von Konversationen und Senden von Nachrichten | Dialoge |
| Parser | Zusammenstellung von Teilnehmern und Überprüfung von Entitäten | Parser |
Insgesamt erklärt die veröffentlichte Spezifikation 96 Operationen: 35 in Version v2, 60 in Version v1 und eine Dienstüberprüfung des Status.
Versionen v1 und v2#
v2 — die aktuelle Version. Sie basiert auf dem Ressourcenmodell: Entität im Pfad, Aktion in der HTTP-Methode. v1 stammt aus der vorherigen Generation, in der die Aktion im Pfad ausgeführt wurde.
| Aufgabe | v1 | v2 |
|---|---|---|
| Liste der Kampagnen | GET /v1/campaign_list/{client_id} |
GET /v2/campaigns |
| Kampagne erstellen | POST /v1/create_campaign |
POST /v2/campaigns |
| Kampagne aktualisieren | POST /v1/update_campaign |
POST /v2/campaigns/{campaign_id}/update |
| Kampagne löschen | DELETE /v1/campaign |
DELETE /v2/campaigns/{campaign_id} |
| Nachricht senden | POST /v1/accounts/{account_id}/dialogs/send |
POST /v2/accounts/{account_id}/dialogs/{peer_user_id}/messages |
| Kontakte hochladen | POST /v1/contacts/upload/csv und /excel |
POST /v2/campaigns/{campaign_id}/contacts/upload?format=csv|xlsx |
Der Hauptunterschied in der Praxis: in v2 wird die Kunden-ID nicht im Pfad übergeben — sie wird durch das Token bestimmt. In v1 erfordern viele Operationen client_id als expliziten Parameter.
Beginnen Sie mit v2. Wenden Sie sich an v1, wenn Sie bereits eine funktionierende Integration haben oder einen Parser benötigen: dieser ist nur in v1 veröffentlicht. Die vollständige Liste finden Sie im Handbuch v1.
Verfügbarkeit prüfen#
/healthÜberprüfung des Dienststatus. Keine Authentifizierung erforderlich.
Als Autorisierungsheader gesendet. Ihr Schlüssel wird nur von Ihrem Browser für diese Anfrage verwendet — er wird niemals an Docsbook gesendet oder gespeichert.
{ "status": "ok" }Client und Lizenzen#
/v2/clientKontoinformationen, an die das Token gebunden ist.
Wird als Autorisierungsheader gesendet. Ihr Schlüssel wird nur von Ihrem Browser für diese Anfrage verwendet — er wird niemals an Docsbook gesendet oder gespeichert.
/v2/client/licensesListe der Lizenzen des Kunden: aktive Slots und Laufzeiten.
Wird als Autorisierungsheader gesendet. Ihr Schlüssel wird nur von Ihrem Browser für diese Anfrage verwendet — er wird niemals an Docsbook gesendet oder gespeichert.
/v2/client/licenses/activateAktivieren Sie die Lizenz mit dem Code. Der Anfrageinhalt ist JSON.
Wird als Autorisierungsheader gesendet. Ihr Schlüssel wird nur von Ihrem Browser für diese Anfrage verwendet — er wird niemals an Docsbook gesendet oder gespeichert.
/v2/client/licenses/renewVerlängern Sie die aktive Lizenz. Der Anfrageinhalt ist JSON.
Wird als Autorisierungsheader gesendet. Ihr Schlüssel wird nur von Ihrem Browser für diese Anfrage verwendet — er wird niemals an Docsbook gesendet oder gespeichert.
/v2/client/telegram-profilesTelegram-Profil an das Konto binden. Der Anfrageinhalt ist JSON.
Wird als Autorisierungsheader gesendet. Ihr Schlüssel wird nur von Ihrem Browser für diese Anfrage verwendet — er wird niemals an Docsbook gesendet oder gespeichert.
/v2/client/telegram-profiles/{tg_id}Telegram-Profil trennen.
Wird als Autorisierungsheader gesendet. Ihr Schlüssel wird nur von Ihrem Browser für diese Anfrage verwendet — er wird niemals an Docsbook gesendet oder gespeichert.
Telegram-Profil-ID
Bekannte Einschränkungen#
Das TLS-Zertifikat des Hosts api.nexifyneo.com ist selbstsigniert. Der Browser und die meisten HTTP-Clients lehnen standardmäßig die Verbindung mit einem Zertifikatprüfungsfehler ab. Solange das Zertifikat nicht durch eines ersetzt wird, das von einer öffentlichen Zertifizierungsstelle ausgestellt wurde, werden interaktive Anfragen von der Seite und Aufrufe von strengen Clients nicht durchkommen. Klären Sie den aktuellen Status bei den Managern im Bot @NN_official_bot.
Die Anfragekörper sind in der Spezifikation nicht typisiert. Das veröffentlichte OpenAPI-Dokument beschreibt die Körper von POST-Anfragen als freies JSON-Objekt, ohne eine Liste von Feldern. Auf den Seiten des Handbuchs ist angegeben, was die Spezifikation tatsächlich erklärt: Methode, Pfad, Pfad- und Anfrageparameter. Den genauen Inhalt des Körpers klären Sie bitte bei den Managern im Bot.
Weiter#
- Authentifizierung — wie man ein Token überträgt.
- Fehler — das Antwortformat bei Ablehnung und wie man auf eine bestimmte Anfrage verweist.
- Die erste Kampagne über die API starten — durchgängiges Szenario.