API und Webhooks

Was passiert

Apex nennt die Schritte: Ihr System übergibt jeden Kunden, der sich registriert oder abonniert, mit Ihrer eigenen Kennung als geschützten Kunden, die bestehenden gebündelt, höchstens 10.000 in einem Aufruf, und einen Kunden, der kündigt, löscht es, sodass er wieder angeschrieben werden kann. Bei einer Firmenadresse ist die Domain die richtige Wahl, bei einem kostenlosen E-Mail-Anbieter (zum Beispiel gmail.com) die E-Mail-Adresse selbst.

Wo Sie es sehen

Im Chat, in der Antwort von Apex. Den Schlüssel erstellen Sie im Kontomenü unter „API und Webhooks“ in der Ansicht „Schlüssel“.

Einem geschützten Kunden schreibt keine Kampagne, auch keine, die sich an Bestandskunden richtet. Wem Sie schreiben möchten, zum Beispiel in einer Wiederkaufkampagne, den laden Sie in eine Kampagne und markieren ihn nicht als geschützt.

Was passiert

Apex geht die Schritte durch: Das System der Druckerei fordert einen Export der Adressen der Kampagne an, nur die neuen oder alle, liest einen großen Export seitenweise und meldet nach der Aufgabe zur Post für jede Firma das Versanddatum zurück. In den Status „Verschickt“ kann nur eine Firma im Status „Exportiert“ wechseln.

Wo Sie es sehen

Im Chat, in der Antwort von Apex.

Es ist derselbe Export wie in der Oberfläche und erscheint auch unter „Meine Exporte“. Der Testschlüssel liefert in jedem Paket Beispieladressen.

Was passiert

Apex erklärt, dass Sie in der Ansicht „Webhooks“ einen neuen Endpunkt mit der Adresse des CRM anlegen und das Ereignis „Positive Rückmeldung“ ankreuzen müssen. Das Signaturgeheimnis erhält der Entwickler einmal und speichert es. War das CRM eine Zeit lang nicht erreichbar, holt der Abruf der Firmen mit positiver Rückmeldung nach, was in der Zwischenzeit ausgefallen ist.

Wo Sie es sehen

Im Chat, in der Antwort von Apex. Den Endpunkt legen Sie im Kontomenü unter „API und Webhooks“ in der Ansicht „Webhooks“ an.

Dieser Webhook übergibt auch Kontakte, deshalb gilt jede Zustellung als Export und erscheint auch unter „Meine Exporte“.

Was passiert

Apex nennt die vier Schritte: Der Entwickler liest den rohen Body, berechnet mit dem Geheimnis des Endpunkts eine HMAC-SHA256-Signatur über den Zeitstempel und den Body, vergleicht sie in konstanter Zeit mit dem v1-Wert des Headers Trendizz-Signature und weist jede Anfrage ab, die älter als 5 Minuten ist. Die Codebeispiele stehen in der Dokumentation.

Wo Sie es sehen

Im Chat, in der Antwort von Apex.

Was passiert

Apex erklärt, dass dafür ein Berichtsschlüssel nötig ist, mit dem Namen der Agentur. Dieser Schlüssel liest nur das Konto und den Kampagnenbericht, als Gesamtwerte und aufgeschlüsselt nach Tag, Woche oder Monat, kann nichts schreiben und lässt sich einzeln widerrufen. Die Agentur nutzt ihn in Ihrem Auftrag in ihrem eigenen System oder in einer Tabelle.

Wo Sie es sehen

Im Chat, in der Antwort von Apex. Den Schlüssel erstellen Sie im Kontomenü unter „API und Webhooks“ in der Ansicht „Schlüssel“.

Der Bericht liefert nur Anzahlen, keine Firmen und keine Kontaktdaten. Die Zahlen sind dieselben wie auf den Kampagnenseiten von Trendizz.

Was passiert

Apex liest das Aufrufprotokoll und sagt Ihnen, was wann, mit welchem Schlüssel und in wessen Namen geschehen ist: die erfolgreichen Aufrufe und bei Fehlern, was der Fehlercode bedeutet. Auf Wunsch öffnet es die Ansicht „Aufrufprotokoll“.

Wo Sie es sehen

Im Chat, in der Antwort von Apex, und rechts in der Ansicht „Aufrufprotokoll“ von API und Webhooks.

Die vollständige Antwort eines Aufrufs, der Daten herausgegeben hat, kann nur die Person öffnen, die den Schlüssel erstellt hat; der Superuser und die Administratoren sehen, wenn sie den Schlüssel nicht erstellt haben, die Zusammenfassung: wie viele Firmen und welche Felder hinausgegangen sind.

Was passiert

Apex liest die Webhook-Endpunkte und die Zustellungen: was hinausgegangen ist, wann, was der Endpunkt geantwortet hat und, wenn der Endpunkt fehlerhaft oder ausgesetzt ist, warum. Es öffnet die Ansicht „Webhooks“, auf Wunsch einen einzelnen Endpunkt.

Wo Sie es sehen

Im Chat, in der Antwort von Apex, und rechts in der Ansicht „Webhooks“.

Erneut senden und wieder aktivieren lässt sich mit den Schaltflächen der Ansicht „Webhooks“; das kann der Superuser des Kontos oder ein Administrator tun.