1. Zuhause
  2. Dokumente
  3. Entwicklerdokumentation
  4. XcooBee SDKs
  5. PHP SDK

PHP SDK

Download und Quelle

https://github.com/XcooBee/xcoobee-php-sdk

Komponist / Packagist:

https://packagist.org/packages/xcoobee/xcoobee-sdk

Lizenz

Veröffentlicht unter: Apache v 2.0

SDK

Das XcooBee PHP SDK ist eine Funktion zum Abstrahieren von Aufrufen auf niedrigerer Ebene und zum Implementieren von Standardverhalten.
Das XcooBee-Team stellt dies zur Verfügung, um die Implementierungsgeschwindigkeit zu verbessern und die Best Practices bei der Interaktion mit XcooBee zu zeigen.

Im Allgemeinen wird die gesamte Kommunikation mit XcooBee über das Kabel verschlüsselt, da keines der XcooBee-Systeme normalen Datenverkehr akzeptiert. Alle von Ihnen an XcooBee gesendeten Daten und umgekehrt werden ebenfalls mit PGP-Protokollen signiert. Die Datenpakete, die Sie erhalten, werden mit Ihrem öffentlichen Schlüssel signiert, und die von Ihnen gesendeten Pakete werden mit Ihrem privaten Schlüssel signiert.

Wenn Sie neue PGP-Schlüssel generieren müssen, können Sie sich bei Ihrem XcooBee-Konto anmelden und dazu auf die Einstellungsseite gehen.

XcooBee-Systeme arbeiten global, jedoch mit regionalen Verbindungen. Das SDK verbindet Sie automatisch mit Ihrem regionalen Endpunkt.

Eine ausführlichere und umfangreichere API-Dokumentation finden Sie auf unserer Dokumentationsseite.

Anruflimits

Wenn Sie Entwicklerkonten verwenden, beachten Sie bitte, dass es ein Anruflimit gibt. Dies sind normalerweise 120 Anrufe pro Stunde oder 600 Anrufe pro 24-Stunden-Zeitraum.

Für Abonnementkonten werden Ihre Anruflimits gemäß Ihrem Konto und Vertrag festgelegt. Wenn Sie Ihre Anruflimits erreicht haben, müssen Sie sich an Ihren Account Manager oder Support wenden, um diese zu erhöhen.

Sobald Sie Ihre Anruflimits überschritten haben, gibt Ihr Anruf den Status zurück 429 Zu viele Anfragen.

Protokolle

Wie alle Standardtransaktionen werden API-Aufrufe im XcooBee-Netzwerk protokolliert. Sie haben die gleiche Zeit zu leben (TTL) Einschränkungen.

Beginnen

API-Endpunkt

Um den Test-API-Endpunkt zu verwenden, legen Sie bitte eine Umgebungsvariable fest XBEE_STATE = Test.

Beispiel:






export XBEE_STATE = test

oder wenn Sie unter Windows sind:






setze XBEE_STATE = test

mit PHP:






putenv ('XBEE_STATE = test');

Das Konfigurationsobjekt

Das Konfigurationsobjekt enthält alle grundlegenden Konfigurationsinformationen für Ihre spezifische Einrichtung und Verwendung. Es kann vom SDK transparent behandelt oder speziell an jede Funktion übergeben werden.
Die grundlegenden Informationen in der Konfiguration sind:

  • Ihr API-Schlüssel von XcooBee
  • Ihr API-Geheimnis von XcooBee
  • Ihr pgp-Geheimnis / Ihre Passphrase entweder von Ihnen oder von XcooBee
  • Ihre Standard-Kampagnen-ID von XcooBee

Das SDK versucht, das Konfigurationsobjekt anhand des folgenden Schemas zu ermitteln:

1.) Verwenden Sie das an die Funktion übergebene Konfigurationsobjekt.

2.) Verwenden Sie die vom Aufruf setConfig festgelegten Informationen.

3.) Überprüfen Sie das Dateisystem auf die Konfigurationsdatei (.xcoobee / config).

Über PGP Secret und Passwort

Alle PGP-Daten sind für das Konfigurationsobjekt optional. Wenn Sie es nicht bereitstellen, überspringt das SDK Entschlüsselungs- / Verschlüsselungsschritte. Sie müssen dies außerhalb des SDK tun und die Daten selbst bereitstellen oder verarbeiten.

Derzeit alle Veranstaltungen Wenn Sie sich über das XcooBee-Netzwerk anmelden, wird mit einer zusätzlichen Ebene der PGP-Verschlüsselung kommuniziert. Sie müssen die Nutzdaten mit Ihrem privaten PGP-Schlüssel entschlüsseln.

Wenn Sie dem SDK den privaten PGP-Schlüssel und seine Passphrase zur Verfügung stellen, entschlüsselt das SDK automatisch die Nutzdaten und stellt Inhalte für die weitere Verarbeitung bereit.

setConfig (configModel)

Das setConfig call ist der Mechanismus zum Erstellen des anfänglichen Konfigurationsobjekts. Sie können es mehrmals verwenden. Bei jedem Anruf überschreiben Sie die vorhandenen Daten. Die einmal gesetzten Daten bleiben bestehen, bis die Bibliothek verworfen wird oder clearConfig wird genannt.






apiKey => der vom XcooBee-Konto bereitgestellte API-Schlüssel apiSecret => das API-Geheimnis (heruntergeladen, als der API-Schlüssel bei XcooBee erstellt wurde) pgpSecret => der von XcooBee generierte oder von Ihnen bereitgestellte pgpPassword => das pgp -Kennwort, das von Ihrer Kampagne angegeben wurdeId => Die Standard-Kampagnen-ID Ihrer Kampagne auf XcooBee pageSize => Paginierungslimit (Datensätze pro Seite), Standard basierend auf Datensatz, maximal möglich 100

clearConfig ()

Entfernt alle Konfigurationsdaten im Konfigurationsobjekt.

Konfiguration im Dateisystem

Das XcooBee SDK durchsucht das Dateisystem nach Konfigurationsinformationen als letzten Mechanismus. Sie sollten sicherstellen, dass der Zugriff auf die Konfigurationsdateien nicht öffentlich und ordnungsgemäß gesichert ist. Sobald die Informationen gefunden wurden, werden sie zwischengespeichert und es wird keine weitere Suche durchgeführt. Wenn Sie Ihre Konfiguration ändern, müssen Sie den Prozess neu starten, der das SDK verwendet, um die Änderungen zu übernehmen.

Wir empfehlen, dass Sie sich auch mit der Verschlüsselung des Inhalts dieser Dateien mit betriebssystemspezifischer Verschlüsselung befassen, die nur von dem Prozess verwendet wird, der das XcooBee SDK verwendet.

Die Dateien befinden sich in Ihrem Zuhause Verzeichnis in der .xcoobee Unterverzeichnis. Der vollständige Pfad zur Konfiguration lautet also:

/[home‹/.xcoobee/config => die Konfigurationsoptionen

/[home‹/.xcoobee/pgp.secret => der geheime pgp-Schlüssel in einer separaten Datei

Unter Windows befindet es sich im Stammverzeichnis Ihres Benutzerverzeichnisses

/Users/MyUserDir/.xcoobee/config => die Konfigurationsoption

/Users/MyUserDir/.xcoobee/pgp.secret => der geheime pgp-Schlüssel in einer separaten Datei

Der anfängliche Inhalt der Konfigurationsdatei besteht aus einfachem Text, wobei jede Option in einer separaten Zeile steht.

Beispieldatei:






apiKey = 8sihfsd89f7 apiSecret = 8937438hf Kampagnen-ID = ifddb4cd9-d6ea-4005-9c7a-aeb104bc30be pgpPassword = somesecret pageSize = 10

Optionen:






apiKey => der API-Schlüssel apiSecret => die API-geheime Kampagnen-ID => die Standard-Kampagnen-ID pgpPassword => das Passwort für Ihren PGP-Schlüssel pageSize => Paginierungslimit

Standardantworten

Das XcooBee-System verfügt über zwei Reaktionsmodi. Einer basiert auf Standard-Web-HTTP-REST-API-Aufrufen und zwei basiert auf asynchronen Webhooks (HTTP-POST), wenn Ereignisse auftreten.

Das Antwortpaket ist in Umschläge und Details gegliedert. Der Umschlag enthält Betriebsergebnisse wie z Error UPC Erfolg und Zeitstempel. Das Detail enthält zugehörige Rückgabedaten für Ihren Anruf. Das XcooBee SDK gibt immer einen Wert zurück, auch wenn es sich um ein Fehlerobjekt handelt. Kurz gesagt, es gibt immer eine Rückkehr. Das Fehlen einer Rückgabe sollte in Standardantworten als Fehler behandelt werden.

Webhook-Antworten (HTTP POST) basieren auf asynchronen Vorgehensweisen. Das XcooBee-System wird Sie über das Ereignis informieren. Diese werden weiter unten in diesem Dokument behandelt.

Erfolgspaket

Objektstruktur für die Antwort:

  • Zeit
  • Code (Antwortcode 200-299)
  • request_id (die zugehörige Anforderungsreferenz)
  • Ergebnis (Datenobjekt)
    • Das Ergebnisobjekt wird mit Ihrem öffentlichen PGP-Schlüssel signiert, wenn dies ein ist Veranstaltung Antwort.

Fehlerpaket

Objektstruktur für die Fehlerantwort:

  • Zeit
  • Code (Antwortcode: 300-500)
  • request_id (die zugehörige Anforderungsreferenz)
  • Fehler (Array von Fehlerobjekten mit Daten: Nachricht, Detail)

Webhook-Ereignisse (HTTP POST)

Über das SDK können Sie viele Ereignisse abonnieren, die im XcooBee-Netzwerk verfügbar sind. Da diese zu unterschiedlichen Zeiten auftreten, müssen Sie in der Lage sein, die Kommunikation von XcooBee über HTTP POST zu einer Zielwebsite zu akzeptieren, die über das Internet verfügbar ist.

Alternativ zu einer öffentlichen Site können Sie den später in diesem Dokument beschriebenen Ereignisabrufmechanismus verwenden, um diese Mitteilung zu erhalten.

Methodik

Bei einer verzögerten Antwort wird der Anruf angenommen und die Antwort über die HTTP-POST-Ereigniskonfiguration zurückgegeben. Ihr System sollte über einen Webendpunkt verfügen, den das XcooBee-System für die Ereignisantworten erreichen kann. Ein Webhook ist kein REST-Endpunkt (HTTP - verbbasiert).

Das Webhook-System verwendet HTTPS POST Anrufe, um Informationen als Antwort auf ein Ereignis in der XcooBee-Verarbeitung an Sie zu senden. Sie abonnieren Ereignisse, indem Sie die System-> addEventSubscription () Methode. Weitere Informationen und Beispiele finden Sie unter examples / addEventSubscription.php In diesem Projekt.

Anrufsysteme sollten sich bewusst sein, dass es zu Verzögerungen kommen kann und dass Antworten in einer anderen Reihenfolge als der Anrufreihenfolge zurückgegeben werden können.

Webhook-Lieferunterschrift

HTTP-POST-Nutzdaten, die an den konfigurierten URL-Endpunkt Ihres Webhooks gesendet werden, enthalten mehrere spezielle Header:

Header Beschreibung
XBEE-EVENT Ereignistyp, der die Zustellung ausgelöst hat. ZB Zustimmung genehmigt
XBEE-TRANS-ID Eine GUID, die dieses Ereignis identifiziert
XBEE-SIGNATUR Der HMAC-Hex-Digest des Antwortkörpers *
XBEE-HANDLER Name einer Funktion, die als Handler für den aktuellen Ereignistyp konfiguriert wurde
  • Das XBEE-SIGNATUR Der Header wird gesendet, wenn der Webhook mit einem Geheimnis konfiguriert ist. Der HMAC-Hex-Digest wird unter Verwendung der sha1-Hash-Funktion und des Geheimnisses als HMAC-Schlüssel generiert.

Implementieren der Webhook-Akzeptanz

Sie können Ihren eigenen Webhook-Akzeptor implementieren und alle an Sie übergebenen Informationen auf diese Weise verarbeiten. Github hat eine gute Standardüberprüfung dieses Prozesses. Github Webhook Beispiele

Verwenden Sie SDK-Tools für die Ereignisbehandlung

Das SDK bietet eine Methode zum Akzeptieren von Webhooks (HTTP POSTS), die:

  • validiert den Inhalt und die Signaturen
  • behandelt die Verschlüsselung / Entschlüsselung
  • verwaltet die Ereignishandler

Dies ist ein mehrstufiger Prozess, der in der endgültigen Implementierung eigentlich einfach ist. Es besteht aus drei Teilen:

a) Bestimmen Sie, wie Sie Ereignisse empfangen möchten

b) Registrieren Sie Ihr Event-Abonnement und Ihre Handler-Paare

c) eingehende Ereignisse verarbeiten

ein Bestimmen Sie, wie Ereignisse empfangen werden sollen

Sie haben zwei Möglichkeiten, wie Sie Ereignisse vom XcooBee-Netzwerk empfangen können. Ereignis-HTTP-Post (Webhook) oder Ereignisabfrage.

HTTP POST

Wenn Sie HTTP POST verwenden möchten, müssen Sie ein über das Internet zugängliches System oder einen Endpunkt angeben, mit dem das XcooBee-Netzwerk direkt kommunizieren kann. Dies geschieht normalerweise über Port 443 (HTTPS / TLS). Wenn beispielsweise im XcooBee-Netzwerk ein Ereignis auftritt und ein Benutzer seine Einverständniserklärung ändert, löst das XcooBee-Netzwerk ein Ereignis für diesen Endpunkt aus.

Sie geben Ihre Ziel-URL beim Einrichten Ihrer Einwilligungskampagne in der XcooBee-Benutzeroberfläche an. Sie können es nicht über das SDK ändern oder einstellen.

Ereignisabfrage

Alternativ können Sie in regelmäßigen Abständen Ereignisse von Ihrem System abrufen. Dies ist nützlich, wenn Sie kein über das Internet zugängliches System haben oder sich im Entwicklungsmodus befinden. Das SDK verfügt über eine unterstützende Methode getEvents Hiermit können Sie alle Ereignisse abrufen, die Sie in den letzten 72 Stunden abonniert haben.

Zu Testzwecken finden Sie auch eine Single Page Application (SPA) in der Poller Verzeichnis dieses Projekts. Es werden Ereignisse abgefragt und erneut an interne Netzwerkendpunkte gesendet.

b Registrieren Sie Ihr Event-Abonnement und Ihre Handler-Paare

Dies ist einer der einfacheren Teile. Wenn Sie Ereignisse mit dem abonnieren addEventSubscription () Sie geben auch die PHP-Funktion an, die Sie aufrufen möchten, wenn ein solches Ereignis als Funktionsargument zurückgegeben wird. Weitere Informationen finden Sie in der Funktionsdefinition.

c Eingehende Ereignisse verarbeiten

Der einfachste Weg, eingehende Ereignisse zu verarbeiten, besteht darin, das aufzurufen handleEvents ([Ereignis]) Methode der System Klasse.

Normalerweise ist dies in Ihrem Site-Endpunkt (Seite) enthalten, der den HTTP-POST von XcooBee empfängt. Wenn Sie eine Ereignisabfrage durchführen, können Sie den gesamten POST-Text als übergeben Veranstaltung zur Funktion.

Diese handleEvents validiert den Anruf und ruft Ihre Handler an, die Sie in Schritt deklariert haben b

Standardendpunkt (Ziel-URL)

Wenn Sie Ereignisse über einen Webhook (HTTP POST) akzeptieren möchten, empfehlen wir, einen Standardendpunkt für die gesamte Kommunikation zu erstellen. Während der Bearbeitung dieser Seite können Sie dann die aufrufen handleEvents () Methode.

Der zu erstellende Standardendpunkt wäre / xbee / webhook

Wenn Ihre Site weiter läuft localhost Die vollständig formulierte Webhook-Ziel-URL wäre http://localhost/xbee/webhook.

Abhängig von Ihrem Framework und Ihrer Syntaxbibliothek kann dies auch sein:

  • /xbee/webhook.php
  • /xbee/webhook.jsp
  • /xbee/webhook.cfm
  • /xbee/webhook.aspx

Systemaufrufe

ping ([config])

Kann aufgerufen werden, um zu sehen, ob die aktuelle Konfiguration eine Verbindung zum XcooBee-System herstellt. Dies gibt einen Fehler zurück, wenn Ihr API-Benutzer keinen öffentlichen PGP-Schlüssel in seinem Profil hat.

Optionen:






config => optional: das Konfigurationsobjekt

Antwort

Standard-JSON-Antwortobjekt

  • Status 200 bei Erfolg
  • Status 400 bei Fehler

addEventSubscription (arrayOfEventAndHandlerPairs [, Kampagnen-ID, Konfiguration])

Sie können Abonnements für Hooks registrieren, indem Sie die Funktion addEventSubscription aufrufen und die Ereignis- (wie in diesem Dokument angegeben) und Handlerpaare angeben eventname => handler.

Es gibt kein Wildcard-Ereignisabonnement. Sie können jedoch mehrere Handler gleichzeitig hinzufügen.

Beispiel:






$xcoobee-> system-> addEventSubscription (['ConsentDeclined' => 'definedHandler'], 'ifddb4cd9-d6ea-4005-9c7a-aeb104bc30be', $config);

Dadurch abonnieren Sie das XcooBee-System, um es zu erhalten ConsentDeclined Veranstaltungen für die ifddb4cd9-d6ea-4005-9c7a-aeb104bc30be Kampagne und rufen Sie Ihren Handler namens abgelehntHandler (Ereignis) wenn ein solches Ereignis eintritt.

Alle Ereignisdaten sind an die angehängt Veranstaltungen Objekt in den Funktionsaufrufen.

Es wird keine Antwort direkt von einem der Ereignishandler erwartet, daher sind die Rückgaben ungültig / null.

Optionen:






arrayOfEventAndHandlerPairs => Array mit Ereignis- und Handlerzuordnungen Kampagne-ID => optional: Die zu verwendende Kampagnen-ID, wenn nicht Standardkonfiguration => Optional: Das Konfigurationsobjekt

Antwort

Standard-JSON-Antwortobjekt

  • Status 200 bei Erfolg
  • Status 400 bei Fehler

listEventSubscriptions ([Kampagnen-ID, Konfiguration])

aktuelle Abonnements auflisten.

Optionen:






Kampagnen-ID => optional: Abonnements nur für die Kampagnen-ID abrufen config => optional: das Konfigurationsobjekt

Antwort

Standard-JSON-Antwortobjekt

  • Status 200 bei Erfolg:
    • Die Daten enthalten den aktuellen Abonnement-Datensatz: Typ, Kampagne, Letzte
  • Status 400 bei Fehler

deleteEventSubscription (arrayOfEventNames [, Kampagnen-ID, Konfiguration])

vorhandene Abonnements löschen.
Wenn Sie keine Kampagnen-ID angeben, wird das Ereignis für die Standard-Kampagnen-ID gelöscht. Wenn das Abonnement nicht existiert, werden wir weiterhin Erfolg zurückgeben.

Optionen:






arrayOfEventNames => Array mit abzumeldenden Ereignisnamen CampaignId => optional: Die zu verwendende Kampagnen-ID, wenn nicht Standardkonfiguration => optional: Das Konfigurationsobjekt

Antwort

Standard-JSON-Antwortobjekt

  • Status 200 bei Erfolg:
    • Die Daten enthalten die Anzahl der gelöschten Abonnements
  • Status 400 bei Fehler

triggerEvent (Typ [, Konfiguration])

Testereignis für konfigurierten Kampagnen-Webhook auslösen. Die Struktur entspricht dem tatsächlichen Ereignis (mit verschlüsselter Nutzlast und HMAC-Signatur).
Auch Sie erhalten XBEE-TEST-EVENT Header, der angibt, dass es sich bei dem Ereignis um einen Test handelt. Wenn der Kampagnen-Webhook nicht konfiguriert ist, wird eine Fehlermeldung angezeigt.

Optionen:






Typ => Name des Ereignisses config => optional: das Konfigurationsobjekt

Antwort

Standard-JSON-Antwortobjekt

  • Status 200 bei Erfolg:
    • Daten enthalten Testereignisdaten
  • Status 400 bei Fehler

handleEvents (Ereignisse)

Diese Funktion erfordert keinen Aufruf der XcooBee-API. Es ist eher der Handler für Anrufe, die Sie erhalten von XcooBee über Webhooks wie zuvor beschrieben.

Sie sollten diese Funktion in den Routen- / Endpunktprozessor einbetten, der aufgerufen wird, wenn XcooBee eines der Ereignisse, für die Sie sich zuvor registriert haben, an Sie zurücksendet. Sie können herausfinden, um welche Ereignisse es sich handelt, indem Sie die aufrufen listEventSubscriptions Methode.

Der Webhook-Beitrag wird auf diese Weise validiert. Wenn der Beitrag gültig ist, werden wir die registrierten Ereignisse untersuchen und die zugeordnete Platzhalterfunktion für jedes Ereignis aufrufen, das mit dem erstellt wurde addEventSubscription () Methode.

Optional kann das Ereignisdatenobjekt zusammen mit den Daten aus dem HTTP-Header und dem POST-Aufruf übergeben werden.

Es gibt zwei Betriebsarten für handleEvents ().

a) Ohne Funktionsparameter Veranstaltungen:

Wenn du anrufst handleEvents () ohne ein Veranstaltungen Funktionsargument sucht die Methode nach den Ereignisdaten im Webhook-Stream (HTTP POST). Überprüfen Sie die HTTP-Signaturen anhand der erwarteten Signaturen und verarbeiten Sie das Ereignis.

b) Mit Funktionsparameter Veranstaltungen:

Wenn Sie separat nach Ereignissen von XcooBee abfragen, können Sie anrufen handleEvents (Ereignisse) direkt mit den Ereignissen. Wenn Sie die Ereignisse speziell angeben, sucht die Methode nicht nach HTTP-POST-Headervariablen zur Überprüfung, sondern verarbeitet Ereignisse direkt wie angegeben.

Optionen:






events => optional: Array von Objekten mit HTTP-Post-Daten

Antwort

  • Keine Antwort, da dies ein interner Aufruf an die zugeordneten Ereignishandler ist

getEvents ([config])

In Fällen, in denen Sie keine direkten Webhook-Beiträge zu Ihren Websites verwenden können, z. B. in der Entwicklung sind oder auf Ihr System nicht direkt über das Internet zugegriffen werden kann, können Sie Ihre Ereignisse von XcooBee abrufen.

Wenn Sie einen Pull-basierten Zugriff verwenden, stellen Sie sicher, dass in Ihrer Kampagne kein Endpunkt definiert ist, da XcooBee andernfalls versucht, auf dem Endpunkt zu posten und einen Fehler zu registrieren. Ohne einen Kampagnenendpunkt speichert XcooBee Ereignisse, die Sie abonnieren, und reagiert auf Ihre Pull-Anfragen.

Sie haben 72 Stunden Zeit, um die gespeicherten Ereignisse abzurufen. Einmal gezogene Ereignisse werden gelöscht. Stellen Sie daher sicher, dass Sie sie speichern, wenn Sie sie erneut abspielen müssen.

Ihr Pull-Intervall sollte nicht mehr als 1 betragen getEvents () Anruf pro Minute, andernfalls wird der HTTP-Fehler 429 zurückgegeben. Wir empfehlen alle 62 Sekunden, um Timerprobleme zu vermeiden.

Optionen:






config => optional: das Konfigurationsobjekt

Antwort

Standard-JSON-Antwortobjekt

  • Status 200 bei Erfolg:
    • Daten enthalten eine Reihe von Ereignissen seit dem letzten Aufruf
  • Status 400 bei Fehler

Zustimmungsverwaltung fordert Zustimmung

getCampaignInfo ([Kampagnen-ID, Konfiguration])

Erhalten Sie grundlegende Informationen zur Kampagne (Setup, Datentypen und Optionen). Die Informationen geben die bei der Kampagne registrierten Benutzer nicht zurück.

Optionen:






Kampagnen-ID => optional: Die zu verwendende Kampagnen-ID, wenn nicht Standardkonfiguration => Optional: Das Konfigurationsobjekt

Antwort

Standard-JSON-Antwortobjekt

  • Status 200 bei Erfolg:
    • Daten enthalten Kampagnendatenobjekt
  • Status 400 bei Fehler

listCampaigns ([config])

Holen Sie sich alle Nutzerkampagnen

Optionen:






config => optional: das Konfigurationsobjekt

Antwort

Standard-JSON-Antwortobjekt

  • Status 200 bei Erfolg:
    • Daten enthalten eine Reihe von Kampagnenobjekten
  • Status 400 bei Fehler

getDataPackage (packagePointer [, config])

IMPLEMENTIERT SEIN:

Wenn Daten bei XcooBee für Sie gehostet werden, können Sie das Datenpaket jedes Mal anfordern, wenn Sie es verwenden müssen. Sie müssen bereitstellen packagePointer. Dieser Anruf antwortet nur auf autorisierte Anrufquellen.

Optionen:






packagePointer => der packagePointer für die Daten, die Sie empfangen möchten config => optional: das Konfigurationsobjekt

Antwort

Standard-JSON-Antwortobjekt

  • Status 200 bei Erfolg:
    • Daten enthalten das angeforderte Datenobjekt
      Das SDK entschlüsselt dies für Sie, wenn es Zugriff auf PGP-Schlüssel hat, andernfalls müssen Sie dieses Objekt entschlüsseln
  • Status 400 bei Fehler

listConsents ([statusIds, config])

Abfrage der Zustimmungsliste für eine bestimmte Kampagne. Das Unternehmen kann eine allgemeine Einwilligungs-ID für jede Einwilligung erhalten, die im Rahmen einer Kampagne erstellt wurde. Dies ist ein mehrseitiges Recordset. Zurückgegebene Daten: Einwilligungs-ID, Erstellungsdatum, Ablaufdatum, xcoobeeId

mögliche Antwort / Filter für Status:

0 = ausstehend, 1 = aktiv, 2 = aktualisiert, 3 = Angebot, 4 = storniert, 5 = abgelaufen, 6 = abgelehnt

Optionen:






statusIds => optional: Array von Zahlen, einer der gültigen Zustimmungsstatus, falls nicht angegeben, werden alle zurückgegeben. config => optional: das Konfigurationsobjekt

Antwort

Standard-JSON-Antwortobjekt

  • Status 200 bei Erfolg:
    • Das Datenobjekt enthält das Einwilligungsdatenobjekt: Einwilligungs-ID, Status-ID, Datum_c, Datum_e, xcoobee_id
  • Status 400 bei Fehler

getConsentData (ZustimmungId [, Konfiguration])

Anfrage für eine bestimmte Einwilligung gegeben. Das Unternehmen kann eine Einwilligungsdefinition für jede erstellte Einwilligung erhalten. Die Daten haben normalerweise drei Bereiche: Wer, welche Datentypen, welche Verwendungszwecke, wie lange.

Optionen:






ZustimmungId => die Einwilligungs-ID, für die Informationen abgerufen werden sollen config => optional: das Konfigurationsobjekt

Antwort

Standard-JSON-Antwortobjekt

  • Status 200 bei Erfolg:
    • Das Datenobjekt enthält ein Einwilligungsdatenobjekt: Benutzer, Datentypen, Einwilligungstypen, Ablauf
  • Status 400 bei Fehler

getCookieConsent (xid [, Kampagnen-ID, Konfiguration])

Dies ist ein Verknüpfungsmechanismus zum Abfragen des XcooBee-Systems nach vorhandener Benutzereinwilligung für den Einwilligungstyp Website-Tracking (1400), Webanwendungsverfolgung (1410) für bestimmte Verwendungsdatentypen (Anwendungscookie (1600), Nutzungscookie (1610) und Werbecookie (1620)). Wir werden nur die aktive Zustimmung zu den Cookies auf der in der Kampagnen-ID angegebenen Website einholen und zurückgeben, ob der Benutzer Cookies zugestimmt hat.

Hinweis:

  • Ihre Website in Ihrer Kampagne muss mit dem Ursprung des Anrufs übereinstimmen, da wir in diesem Anruf aus Gründen der Geschwindigkeit keine PGP-Verschlüsselung verwenden.
  • Der Benutzer muss bei XcooBee angemeldet sein

Die Rückgabe ist eine CSV-Liste wie folgt:

  • Anwendung, Nutzung, Werbung

Optionen:






xid => XcooBee-ID des Benutzers, der auf Zustimmung überprüft werden soll kampagnen-ID => optional: Die zu verwendende Kampagnen-ID, wenn nicht Standardkonfiguration => optional: Das Konfigurationsobjekt

Antwort

Standard-JSON-Antwortobjekt

  • Status 200 bei Erfolg:
    • Das Datenobjekt enthält die Website-Cookie-Zustimmung CSV: Anwendung, Verwendung, Werbung
  • Status 400 bei Fehler

requestConsent (xid [, refId, CampaignId, config])

Sendet die Einwilligung oder Einwilligung und Datenanforderung an einen bestimmten Benutzer unter Verwendung der Daten in der Kampagne. Die Kampagnendefinition bestimmt, welche Daten (nur Zustimmung oder Zustimmung + Daten) vom Benutzer angefordert werden.

Optionen:






xid => XcooBee-ID des Benutzers, der auf Zustimmung überprüft werden soll refId => optional: Von Ihnen generierte Referenz-ID, die diese Anforderung an Sie identifiziert. Maximal 64 Zeichen. Dies wird Ihnen in der Ereignisantwort zurückgegeben. CampaignId => optional: Die zu verwendende Kampagnen-ID, wenn nicht die Standardkonfiguration => optional: das Konfigurationsobjekt

Wenn der Benutzer auf die Einwilligungsanfrage antwortet, wird ein Webhook von XcooBee an den identifizierten Endpunkt in der Kampagne ausgelöst. Mit dem SDK können keine Endpunkte erstellt oder geändert werden. Bitte benutzen Sie die GUI.

Antwort

Standard-JSON-Antwortobjekt

  • Status 200 bei Erfolg:
    • Datenobjekt enthält true
  • Status 400 bei Fehler

verifyConsentChange (ZustimmungId [, Konfiguration])

Verwenden Sie diesen Aufruf, um zu bestätigen, dass Daten in Unternehmenssystemen entsprechend der vom Benutzer angeforderten Änderung geändert wurden.

Optionen:






ZustimmungId => die Zustimmung, für die Daten bestätigt werden sollen config => optional: das Konfigurationsobjekt

Antwort

Standard-JSON-Antwortobjekt

  • Status 200 bei Erfolg:
    • Datenobjekt enthält true
  • Status 400 bei Fehler

bestätigeDataDelete (Einwilligungs-ID [, Konfiguration])

Von Unternehmen senden, um zu bestätigen, dass Daten aus Unternehmenssystemen gelöscht wurden

Optionen:






ZustimmungId => die Zustimmung, für die Daten gelöscht wurden config => optional: das Konfigurationsobjekt

Antwort

Standard-JSON-Antwortobjekt

  • Status 200 bei Erfolg:
    • Datenobjekt enthält true
  • Status 400 bei Fehler

setUserDataResponse (Nachricht, Einwilligungs-ID [, requestRef, Dateiname, Konfiguration])

Unternehmen können auf Benutzerdaten reagieren, die über diesen Anruf angefordert wurden. Hierfür werden Standard-Einstellungspunkte abgezogen. Der Anruf sendet eine Botschaft zum Kommunikationszentrum des Benutzers. Sie müssen auch eine Datei mit Benutzerdaten senden, um die Datenanforderung zu schließen.

Optionen:






message => der Text, der als Benutzerdaten-Einwilligung an den Benutzer gesendet werden sollId => die Einwilligung, für die Daten gelöscht wurden requestRef => optional: eindeutige Kennung der Datenanforderung, diese erhalten Sie bei `UserDataRequest`-Ereignisdateiname => optional : Zeiger auf die Datei, die die Benutzerdaten enthält config => optional: das Konfigurationsobjekt

Antwort

Standard-JSON-Antwortobjekt

  • Status 200 bei Erfolg:
    • Datenobjekt enthält true
  • Status 400 bei Fehler

Hierbei handelt es sich um Ereignisse, die als Teil des Benutzers, der mit seinem Einwilligungscenter arbeitet, an Ihren Endpunkt zurückgegeben werden. Alle Endpunkte werden in jeder Zustimmungskampagne festgelegt.

Zustimmung genehmigt

Wird ausgelöst, wenn eine Zustimmungsanfrage genehmigt wird. Das Zustimmungsobjekt wird zurückgegeben.
Es beinhaltet:

  • Zustimmungsreferenz
  • Datentypen
  • Zustimmungsarten
  • Ablauf

ConsentDeclined

Wird ausgelöst, wenn eine Zustimmungsanfrage abgelehnt wird. Sie sollten Benutzerdaten entfernen und eine XcooBee-Bestätigung über senden verifyDataDelete ().
Die übermittelten Daten enthalten:

  • Zustimmungsreferenz

ConsentChanged

Wird ausgelöst, wenn die Zustimmung geändert wird. Ein Standardzustimmungsobjekt wird zurückgegeben.
Es beinhaltet:

  • Zustimmungsreferenz
  • Datentypen
  • Zustimmungsarten
  • Ablauf

ConsentNearExpiration

Wird ausgelöst, wenn eine aktive Einwilligung abläuft (innerhalb von 30 Tagen). Dies sind nicht genau 30 Tage, da die XcooBee-Systemprozesse dies möglicherweise geringfügig vorantreiben. Sie sollten die Erneuerung der Einwilligung beantragen, wenn Sie die Benutzerdaten länger verwenden möchten.
Es beinhaltet:

  • Zustimmungsreferenz
  • Ablauf

Zustimmung abgelaufen

Wird ausgelöst, wenn die Einwilligung abgelaufen ist. Sie sollten Benutzerdaten entfernen und eine XcooBee-Bestätigung über senden verifyDataDelete ().
Es beinhaltet:

  • Zustimmungsreferenz

UserDataRequest

Wird ausgelöst, wenn der Benutzer eine Anforderung zum Extrahieren seiner aktuellen Daten von Ihren Systemen stellt. Dies dient dazu, die Datenportabilität der DSGVO zu gewährleisten. Sie sollten einen Datenextrakt erstellen und an die XcooBee-Box des Benutzers senden. Sie können dies tun, indem Sie die xcoobee-Datenantwort Biene mit der GUID-Referenz der Anfrage.
Es beinhaltet:

  • Zustimmungsreferenz
  • xcoobeeId

UserMessage

Wird ausgelöst, wenn der Benutzer Ihnen eine Nachricht bezüglich einer Zustimmungsanforderung sendet.
Ihre Kampagne kann diese Funktion im aktivieren / deaktivieren Kampagnenoptionen. Sie können darauf mit a antworten sendUserMessage () Anruf.
Es beinhaltet:

  • Zustimmungsreferenz
  • xcoobeeId
  • Botschaft

Zustimmungsverwaltung fordert Daten

Dieser Abschnitt behandelt Ereignisse, die im Zusammenhang mit der Erfassung von Daten und der gleichzeitigen Einwilligung verwendet werden.

Datenereignisse (Webhooks)

Von XooBee an Ihr System gesendete Ereignisse.

DataApproved

Wird ausgelöst, wenn die Zustimmung erteilt wurde und die Daten vom Benutzer bereitgestellt wurden. Ein Standardzustimmungsobjekt wird zurückgegeben.
Es beinhaltet:

  • Zustimmungsreferenz
  • Datentypen mit Daten
  • Zustimmungsarten
  • Ablauf

DataDeclined

Wird ausgelöst, wenn der Benutzer die Bereitstellung von Daten und Einwilligung ablehnt. Sie sollten Benutzerdaten entfernen und eine XcooBee-Bestätigung über senden verifyDataDelete ().
Es beinhaltet:

  • Zustimmungsreferenz

DataChanged

Wird ausgelöst, wenn Daten oder Einwilligungen geändert werden. Ein Standardzustimmungsobjekt wird zurückgegeben.
Es beinhaltet:

  • Zustimmungsreferenz
  • Datentypen mit Daten
  • Zustimmungsarten
  • Ablauf

DataNearExpiration

Wird ausgelöst, wenn eine aktive Einwilligung abläuft (innerhalb von 30 Tagen).
Dies sind nicht genau 30 Tage, da die XcooBee-Systemprozesse dies möglicherweise geringfügig vorantreiben.
Sie sollten die Erneuerung der Einwilligung beantragen, wenn Sie die Benutzerdaten länger verwenden möchten.
Es beinhaltet:

  • Zustimmungsreferenz
  • Ablauf

Daten abgelaufen

Wird ausgelöst, wenn die Daten abgelaufen sind. Sie sollten Benutzerdaten entfernen und eine XcooBee-Bestätigung über senden verifyDataDelete ().
Es beinhaltet:

  • Zustimmungsreferenz

UserDataRequest

Wird ausgelöst, wenn der Benutzer eine Anforderung zum Extrahieren seiner aktuellen Daten von Ihren Systemen stellt.
Dies dient dazu, die Datenportabilität der DSGVO zu gewährleisten.
Sie sollten einen Datenextrakt erstellen und an die XcooBee-Box des Benutzers senden.
Sie können dies tun, indem Sie die xcoobee-Datenantwort Biene mit der GUID-Referenz der Anfrage.
Es beinhaltet:

  • Zustimmungsreferenz
  • xcoobeeId

UserMessage

Wird ausgelöst, wenn der Benutzer Ihnen eine Nachricht bezüglich einer Zustimmungsanforderung sendet.
Ihre Kampagne kann diese Funktion im aktivieren / deaktivieren Kampagnenoptionen. Sie können darauf mit dem antworten sendUserMessage () Funktion.
Es beinhaltet:

  • Zustimmungsreferenz
  • xcoobeeId
  • Botschaft

Botschaft

sendUserMessage (Nachricht, Einwilligung, [Verstoß], [Konfiguration])

Mit dieser Funktion können Sie eine Nachricht an Benutzer senden. Auf diese Weise können Sie Probleme in Bezug auf Verstöße, Einwilligungen und Daten kommunizieren. Es wird eine Diskussionsrunde für den Benutzer und für Sie erstellt und diese Nachricht angehängt.

Optionen:






message => Der Text, der als Benutzerdaten an den Benutzer gesendet werden soll, kann im HTML-Format formatiert werden. Maximal 2000 Zeichen ZustimmungId => die Zustimmungs-ID, die die Benachrichtigung auslöstId => optional: Verwandte Verletzung, Benutzer erhält eine Nachricht mit vorgeschlagenen Aktionen, die in einer Verstoßkonfiguration deklariert sind => optional: das Konfigurationsobjekt

Antwort

Standard-JSON-Antwortobjekt

  • Status 200 bei Erfolg:
    • Datenobjekt enthält true
  • Status 400 bei Fehler

getConversations ([config])

Mit dieser Funktion können Sie eine Liste mit Diskussionen mit Benutzern über Verstöße, Zustimmungen usw. abrufen.

Optionen:






config => optional: das Konfigurationsobjekt

Antwort

Standard-JSON-Antwortobjekt

  • Status 200 bei Erfolg:
    • Datenobjekt enthält true
  • Status 400 bei Fehler

getConversation (userId [, config])

Mit dieser Funktion können Sie eine vollständige Diskussion mit dem ausgewählten Benutzer führen.

Optionen:






userId => die Benutzer-ID config => optional: das Konfigurationsobjekt

Antwort

Standard-JSON-Antwortobjekt

  • Status 200 bei Erfolg:
    • Datenobjekt enthält true
  • Status 400 bei Fehler

Bruch

Die Verstoß-API ist die Hauptmethode für die Interaktion mit Benutzern während eines Verstoßes. Die Verstoßerklärung und die ersten Benachrichtigungen erfolgen in der Benutzeroberfläche.

Breach Events (Webhooks)

BreachPresented

Wird ausgelöst, wenn der Benutzer einen Verstoßhinweis geöffnet hat.
Es beinhaltet:

  • Zustimmungsreferenz

BreachBeeUsed

Wird ausgelöst, wenn der Benutzer eine Biene verwendet hat, die Sie in der Verstoßempfehlung angegeben haben.
Es beinhaltet:

  • Zustimmungsreferenz
  • Bienenreferenz

UserMessage

Wird ausgelöst, wenn der Benutzer Ihnen eine Nachricht bezüglich einer Zustimmungsanforderung sendet.
Ihre Kampagne kann diese Funktion im aktivieren / deaktivieren Kampagnenoptionen. Sie können darauf mit dem antworten sendUserMessage () Funktion.
Es beinhaltet:

  • Zustimmungsreferenz
  • xcoobeeId
  • Botschaft

Bienen-API

Die Bee API ist die Hauptschnittstelle zum Mieten von Bienen. In den meisten Fällen erfolgt dies in zwei Schritten. Im ersten Schritt laden Sie Ihre Dateien hoch, die von Bienen mit verarbeitet werden sollen Daten hochladen() Anruf. Wenn Sie keinen Postausgangsendpunkt angegeben haben, müssen Sie auch den aufrufen ausziehen, starten, abheben, losfahren() Funktion mit den Verarbeitungsparametern für die Biene.

Die sofortige Antwort deckt nur Probleme mit Dateien für die erste Biene ab. Wenn Sie über den Fortschritt der Verarbeitung informiert werden möchten, müssen Sie Ereignisse abonnieren.

listBees (searchText [, config])

Diese Funktion hilft Ihnen beim Durchsuchen der Bienen in dem System, das Ihr Konto einstellen kann. Dies ist eine einfache Keyword-Suchoberfläche.

Optionen:






Suchtext => Zeichenfolge von Schlüsselwörtern, nach denen im Namen oder Etikett des Bienensystems in der Sprache Ihres Kontos gesucht werden soll config => optional: das Konfigurationsobjekt

Antwort

Standard-JSON-Antwortobjekt

  • Status 200 bei Erfolg:
    • Das Datenobjekt enthält grundlegende Bienendaten: Bienensystemname, Bienenbezeichnung, Bienenkosten, Kostentyp
  • Status 400 bei Fehler

uploadFiles (Dateien [, Endpunkt, Konfiguration])

Mit der Funktion uploadFiles können Sie Dateien von Ihrem Server auf XcooBee hochladen. Sie können mehrere Dateien hochladen und optional einen Postausgangsendpunkt angeben. Wenn Sie einen Postausgangsendpunkt haben, müssen Sie den nicht anrufen ausziehen, starten, abheben, losfahren Funktion als Endpunkt gibt bereits alle Verarbeitungsparameter an. Wenn Ihr Abonnement dies zulässt, können Sie die Postausgangsendpunkte in der XcooBee-Benutzeroberfläche konfigurieren.

Optionen:






files => Array von Zeichenfolgen mit Dateizeigern auf den Dateispeicher, z. B.: `c: \ temp \ mypic.jpg` oder` / home / mypic.jpg` endpoint => optional: der Outbox-Endpunkt, z `POS Drop Point` config => optional: das Konfigurationsobjekt

Antwort

Standard-JSON-Antwortobjekt

  • Status 200 bei Erfolg:
    • Datenobjekt enthält true
  • Status 400 bei Fehler

takeOff (Bienen, Optionen [, Abonnements, Konfiguration])

Normalerweise verwenden Sie dies als Folgeanruf an Daten hochladen(). Dadurch wird Ihre Verarbeitung gestartet. Sie geben die Biene (n) an, die Sie einstellen möchten, und die Parameter, die die Biene benötigt, um an Ihren Dateien zu arbeiten. Wenn Sie auf dem Laufenden gehalten werden möchten, können Sie Abonnements bereitstellen. Bitte beachten Sie, dass Abonnements Punkte von Ihrem Guthaben abziehen und Fehler verursachen, wenn Ihr Guthaben nicht ausreicht.

Dies ist der komplexeste Funktionsaufruf in der Bee-API und verfügt über mehrere Optionen und Teile.

a) Parameter
b) Abonnements
c) Abonnementereignisse

Optionen:






Bienen => Array von Bienensystemnamen (z. B. "xcoobee_digital_signature_detection") als Schlüssel und deren Parameter als Wertoptionen => allgemeine Optionen Abonnements => optional: das Abonnement-Array. Gibt die Abonnements config => optional an: das Konfigurationsarray

ein Parameter

Die Parameter können bienenspezifisch sein oder sich auf den Gesamtjob beziehen.

Beispiel für bestimmte Bienenparameter:






$bees ['xcoobee_testbee'] = ['height' => 599, 'width' => 1200,];

Die für die Einstellung zu verwendenden allgemeinen Jobparameter sind mit dem angegeben Prozess Präfix einschließlich der Ziele (Empfänger), an die Sie die Ausgabe der Verarbeitung senden möchten.

Beispiel für allgemeine Prozessparameter:






$options ['process'] ['userReference'] = 'myownreference'; $options ['process'] ['destinations'] = ['email @ null mysite.com', '~ jonny']; $options ['process'] ['fileNames] = [' filename.png '];

Für die angegebenen Bienenparameter ist das Präfix des Bienennamens erforderlich. Wenn der Bienenname ist xcoobee_testbee und es erfordert zwei Parameter Höhe und Breite Dann müssen Sie diese in ein assoziatives Array innerhalb des Parameter-Arrays mit einem Schlüsselnamen hinzufügen.

b Abonnements

Abonnements können an den Gesamtprozess angehängt werden. Sie müssen a angeben Ziel, ein Veranstaltungen und ein Handler Argument mindestens. Das Ziel Der Endpunkt muss über das XcooBee-System über erreichbar sein HTTP / S POST. Das Veranstaltungen legt fest, welche Ereignisse Sie abonnieren.

Somit sind die drei Schlüssel für jedes Abonnement:

  • Ziel => Zeichenfolge mit Zielendpunkt-URL
  • events => Array mit Lebenszyklusereignissen, die abonniert werden sollen
  • Handler => erforderlich: Die PHP-Funktion, die aufgerufen wird, wenn Bienen-API-Ereignisse vorliegen

Die HMAC-Signatur nimmt Ihre XcooBee-ID als gemeinsam genutzten geheimen Schlüssel an und verwendet den öffentlichen PGP-Schlüssel zum Verschlüsseln der Nutzdaten. Ohne dies verwenden Sie immer noch die SSL-Verschlüsselung für die Übertragung.

Um allgemeine Prozessereignisse zu abonnieren, das Schlüsselwort Prozess muss verwendet werden. Die Abonnementdetails müssen als Unterschlüssel angehängt werden.

Denken Sie daran, dass Abonnements Punkte von Ihrem Guthaben abziehen, auch wenn sie nicht erfolgreich sind. Überprüfen Sie daher bitte die Endpunkte, die Sie in angegeben haben Ziel sind gültig.

Beispiel für ein Abonnement des Gesamtprozesses.

Beispiel für Abonnements:






Abonnements verarbeiten: $subscriptions ['target'] = "https://mysite.com/beehire/notification/" $subscriptions ['events'] = ["Fehler", "Erfolg", "Zustellung", "Gegenwart", "Download" "," delete "," reroute "] $subscriptions ['handler] =" myBeeEventHandler "

c Abonnementereignisse

Das Ereignissystem für Bienen verwendet Ereignisse auf Prozessebene.

Ereignisse auf Prozessebene

  • Error
    • Bei der Verarbeitung der Transaktion ist ein Fehler aufgetreten. Wenn es mehrere Fehler gibt, wird jeder von ihnen in einem separaten Post gesendet.
    • Ereignistyp im POST-Header gesendet - ProcessError
  • Erfolg
    • Die gesamte Transaktion wurde erfolgreich abgeschlossen
    • Ereignistyp im POST-Header gesendet - ProcessSuccess
  • liefern
    • Wurde eine Datei übertragen, wurde die Datei in den Posteingang des Empfängers geliefert
    • Ereignistyp im POST-Header gesendet - ProcessFileDelivered
  • Geschenk
    • Wenn eine Datei übertragen wurde, wurde die Datei vom Benutzer gesehen
    • Ereignistyp im POST-Header gesendet - ProcessFilePresented
  • herunterladen
    • Wenn eine Datei übertragen wurde und der Benutzer die Datei heruntergeladen hat
    • Ereignistyp im POST-Header gesendet - ProcessFileDownloaded
  • löschen
    • Dieses Ereignis tritt auf, wenn der Benutzer die Datei löscht
    • Ereignistyp im POST-Header gesendet - ProcessFileDeleted
  • umleiten
    • Wenn der Benutzer Posteingangsregeln automatisiert hat und das Dokument an einen anderen Ort gesendet wurde, wird ein Umleitungsereignis ausgelöst
    • Ereignistyp im POST-Header gesendet - ProcessReroute

Beispiele für Ereignisnutzdaten:

  • Beispiel für ein Erfolgsereignis:





{"Datum": "2017-12-04T16: 50: 40.698Z", "Datei": "myImage.jpg", "userReference": "88jenr", "Empfänger": "~ john873", "Ereignis": " Erfolg "," eventLevel ":" Biene "," Quelle ":" Block4-Post "," Bienenname ":" xcoobee_image_resizer "," Transaktionsname ":" 9SDd8ccb "}
  • Beispiel für ein Fehlerereignis:





{"Datum": "2017-10-24T15: 22: 39.209Z", "Datei": "myhome2.jpg", "userReference": "keine Referenz", "Empfänger": "kein Empfänger", "Ereignis" ":" error "," eventLevel ":" bee "," source ":" Block4-post "," beeName ":" xcoobee_image_converter "," message ":" Timeout-Fehler beim Containerprozess "," transactionName ":" 0P4bbee " "}

Antwort

Standard-JSON-Antwortobjekt

  • Status 200 bei Erfolg:
    • Datenobjekt enthält true
  • Status 400 bei Fehler

Posteingang-API

Die Posteingangs-API regelt den Zugriff auf Ihren Posteingang. Sie können Elemente in Ihrem Posteingang auflisten, herunterladen und löschen.

listInbox ([config])

Diese Methode zeigt eine ausgelagerte Liste der Posteingangselemente an, die Sie herunterladen können. Die Auflistung gilt für den Benutzer, der mit Ihrem API-Schlüssel verbunden ist. Mit dieser Methode können Sie den Posteingang eines anderen Benutzers nicht überprüfen. Sie können bis zu 100 Artikel in einem Anruf zurückgeben.
Das mehrmalige Aufrufen dieser Methode pro Minute führt zu einem HTTP 429-Fehler (Überschreiten der Anruflimits).

Sie erhalten folgende Datenpunkte:

  • Nachrichten ID
  • Absender
  • Dateiname
  • Dateigröße (in Bytes)
  • Eingangsdatum
  • Haltbarkeitsdatum
  • downloadDate

Posteingangspositionen werden in der Reihenfolge ihrer Ankunft aufgelistet, wobei die neuesten Artikel zuerst angezeigt werden.

Optionen:






config => optional: das Konfigurationsobjekt

Antwort

Standard-JSON-Antwortobjekt

  • Status 200 bei Erfolg:
    • Das Datenobjekt enthält eine Liste der Posteingangselemente im Array: Nachrichten-ID, Absender, Dateiname, Dateigröße, Empfangsdatum, Ablaufdatum, Downloaddatum
  • Status 400 bei Fehler

getInboxItem (messageId [, config])

Diese Methode gibt eine Datei und Datei-Meta-Tags zurück. Beim ersten Herunterladen wird die downloadDate für den Artikel wird ausgefüllt.

Optionen:






messageId => die Nachrichten-ID für die herunterzuladende Datei config => optional: das Konfigurationsobjekt

Antwort

Standard-JSON-Antwortobjekt

  • Status 200 bei Erfolg:
    • Das Datenobjekt enthält die Datei und das file_meta-Objekt (userRef, fileType, fileTags).
  • Status 400 bei Fehler

deleteInboxItem (messageId [, config])

Diese Methode löscht eine Datei, die Ihrer Nachrichten-ID entspricht. Wenn die Datei nicht vorhanden ist, wird ein Fehler zurückgegeben.

Optionen:






messageId => die Nachrichten-ID für die zu löschende Datei config => optional: das Konfigurationsobjekt

Antwort

Standard-JSON-Antwortobjekt

  • Status 200 bei Erfolg:
    • Datenobjekt enthält true
  • Status 400 bei Fehler

Benutzer-API

getUserPublicKey (xid [, config])

Ruft den öffentlichen PGP-Schlüssel eines Benutzers ab, der in seinem öffentlichen Profil veröffentlicht wurde. Wenn der Benutzer es ausgeblendet hat oder der Benutzer nicht bekannt ist, wird es zurückgegeben Null.

Beispiel:






getUserPublicKey ('~ XcooBeeId');

Optionen:






xid => XcooBee ID des Benutzers, der seinen öffentlichen PGP-Schlüssel erhalten soll config => optional: das Konfigurationsobjekt

Antwort

öffentliches PGP oder Null

Fehlerbehebung

Fehler 401

Bestimmte SDK-Aufrufe erfordern autorisierte Ursprünge.

Sie können erhalten 401 Fehlerantworten von XcooBee, wenn Ihr API-Aufruf von einer nicht autorisierten Domain oder IP stammt. Bitte stellen Sie sicher, dass Sie Ihre Domain in Ihrer XcooBee-Kampagne registriert haben CallBack-URL Möglichkeit.

Fehler 429

Sobald Sie Ihre Anruflimits überschritten haben, gibt Ihr Anruf den Status zurück 429 Zu viele Anfragen. Bitte aktualisieren Sie Ihr Abonnement oder wenden Sie sich an den Support.

Fandest du diesen Artikel hilfreich? Ja Nein

Wie können wir helfen?