Wer ihn verwenden kann
API-Basis-URL
Diese Karte zeigt die Adresse der REST API. Verwenden Sie in Ihrer Integrationhttps://api.flowella.io/v1 als Basis-URL, auch wenn die Karte eine Adresse mit der Endung /api/v1 anzeigt. Den Grund dafür finden Sie unter Basis-URL.
Letzte API-Anfragen
Diese Karte listet die 25 neuesten API-Anfragen an Ihre Organisation auf, die mit API-Schlüsseln oder OAuth-Access-Tokens gestellt wurden, die neueste zuerst.
Anfragen, die Flowella vor der Ausführung ablehnt, werden nicht aufgeführt. Dazu gehören Anfragen mit fehlendem oder ungültigem Token, fehlendem Scope, einem nicht unterstützten Header
API-Version oder solche über dem Ratenlimit.
Um alles zu sehen, was mit einer Anfrage verknüpft ist, etwa die ausgelösten Ereignisse, Jobs und Webhook-Zustellungen, rufen Sie GET /v1/requests/{requestId} mit der Request id auf. Dafür ist der Scope account:read erforderlich. Siehe Request-IDs.
API-Sandbox
Die Karte API sandbox enthält einen organisationsweiten Schalter zum Testen, ohne etwas an WhatsApp zu senden. Das Badge zeigt Active, wenn die Sandbox eingeschaltet ist, und Off, wenn sie ausgeschaltet ist. Sandbox guide öffnet den Sandbox-Leitfaden in der App. Um die Sandbox einzuschalten, aktiviert ein Owner oder Admin das Kontrollkästchen unten auf der Karte. Deaktivieren Sie es, um die Sandbox auszuschalten. Die Änderung gilt sofort für die gesamte Organisation. Sie können die Einstellung auch mitGET /v1/sandbox und PATCH /v1/sandbox lesen und ändern, mit dem Body { "enabled": true } oder { "enabled": false }. Beide benötigen den Scope sandbox:manage.
API-Sandbox und Sandbox-Schlüssel
Es gibt zwei Möglichkeiten, die Sandbox zu nutzen. Die organisationsweite API sandbox gilt für jede Anfrage, ein Sandbox-Schlüssel dagegen nur für die Anfragen, die mit diesem Schlüssel gestellt werden.Was sich in der Sandbox ändert
Wenn die Sandbox eine Anfrage abdeckt:POST /v1/messagesspeichert die Nachricht in der Konversation und gibt"sandbox": truemitmetaMessageIdgleichnullzurück. Nichts erreicht WhatsApp, und es wird kein Webhookmessage.sentausgelöst.- Das Einreichen von Vorlagen mit
POST /v1/templates/{id}/submiterreicht Meta nicht. Die Vorlage wird sofort genehmigt oder abgelehnt, wenn der Vorlagennamereject_enthält. Ein Medien-Header, dessen Beispiel nur eine Webadresse ist, wird mit400 INVALID_TEMPLATE_COMPONENTSabgelehnt. Die Entscheidung erscheint in der API und im Ereignis-Feed, aber die Seite Templates in der App ändert sich nicht. - Die Sandbox läuft in Ihrer echten Organisation. Kontakte, Konversationen und Nachrichten, die bei Tests entstehen, werden wie alle anderen gespeichert und erscheinen in der App.
Sandbox-Testwerkzeuge
Diese Endpunkte helfen Ihnen, Aktivität zu simulieren. Sie benötigen den Scopesandbox:manage und funktionieren unabhängig davon, ob die Sandbox eingeschaltet ist. Verwenden Sie sie daher nur mit Testdaten.
Die Testwerkzeuge schreiben nur in den Ereignis-Feed (
GET /v1/events). Sie senden keine Webhooks und ändern die Nachricht selbst nicht.
Schnellstarts
Die Karte Quickstarts verlinkt auf Schritt-für-Schritt-Anleitungen. Jede öffnet sich als Markdown-Datei in einem neuen Tab.Links
Verwandt
API-Einführung
Authentifizierung, Scopes, Ratenlimits und Fehler.
API-Schlüssel
Live- und Sandbox-Schlüssel erstellen.
Entwickler-Apps
Eine OAuth-App registrieren und installierte Apps verwalten.
Webhooks-Referenz
Ereignistypen, Payloads und Signaturprüfungen.