AIDA Zapier
Zapier ist ein Ziel (Beta), das jedes in AIDA freigegebene Dokument an einen Zap sendet. So können Sie seine Daten und das PDF an Tausende von Apps weiterleiten (Google Sheets, Slack, Ihr ERP und mehr).
AIDA mit Zapier verbinden
- Öffnen Sie in AIDA den Dokumenttyp, fügen Sie das Ziel Zapier hinzu und speichern Sie.
- Kopieren Sie den Schlüssel des Ziels.
- Erstellen Sie in Zapier einen Zap mit dem Trigger AIDA → Document Approved. Fügen Sie den Schlüssel ein, wenn Sie zur Verbindung aufgefordert werden. Die Verbindung trägt den Namen des Dokumenttyps.
- Testen Sie den Trigger: Zapier lädt die drei zuletzt verarbeiteten Dokumente dieses Typs als Beispiele. Geben Sie vorher mindestens ein Dokument frei.
- Fügen Sie die benötigten Aktionen hinzu, ordnen Sie die Felder zu und veröffentlichen Sie den Zap.
Ab dann wird jedes mit diesem Ziel freigegebene Dokument an den Zap gesendet. Die Schaltfläche Ihre Zaps öffnen im Ziel öffnet Ihre Zaps in Zapier.
note
Jedes Zapier-Ziel versorgt genau einen Zap: Wenn Sie einen neuen Zap mit demselben Schlüssel verbinden, wird der vorherige ersetzt. Um mehrere Zaps zu versorgen, fügen Sie mehrere Zapier-Ziele hinzu. Wenn Sie den Schlüssel neu generieren, wird der Zap getrennt.
Wird der Zap ausgeschaltet oder gelöscht, wird das Ziel getrennt, und neue Freigaben enden mit dem Fehler zapierNotConnected, bis wieder ein Zap verbunden ist.
Payload
Jedes freigegebene Dokument wird als JSON-Objekt gesendet. Die in Zapier angezeigten Beispieldatensätze haben dasselbe Format.
| Feld | Typ | Beschreibung |
|---|---|---|
id | string | Die ID des Dokuments in AIDA. |
documentName | string | Der Name des Dokuments. |
documentConfigurationName | string | Der Name des Dokumenttyps. |
documentURL | string | Ein dauerhafter Link, um das Dokument in der AIDA-Webanwendung anzuzeigen. |
downloadURL | string | Ein temporärer, sicherer Link zum Herunterladen des PDFs. Er läuft nach 7 Tagen ab. |
Die extrahierten Eigenschaften folgen denselben Regeln wie beim Webhook-Ziel: Der Schlüssel ist das Output Mapping der Eigenschaft oder, falls nicht gesetzt, ihre Bezeichnung, Werte werden in ihren JSON-Typ umgewandelt und Tabellen werden zu Arrays. Anders als beim Webhook sind Datumswerte ISO-8601-Zeichenketten in UTC (zum Beispiel 2025-10-14T00:00:00Z).
{
"Invoice number": "INV-2025-042",
"invoiceDate": "2025-10-14T00:00:00Z",
"total": 122.00,
"lines": [
{ "description": "Product A", "qty": 2, "unitPrice": 50.00 }
],
"id": "12345",
"documentName": "invoice-042.pdf",
"documentConfigurationName": "Invoice",
"documentURL": "https://www.aidacloud.com/app/web/archive/12345",
"downloadURL": "https://api.aidacloud.com/asset/document/generated-auth-token"
}
API-Referenz
Die AIDA-App für Zapier verwendet die folgenden Endpunkte. Die Basis-URL ist https://api.aidacloud.com/api/v1/zapier.
Authentifizierung: Jede Anfrage sendet den Schlüssel des Ziels im Header X-API-Key. Ein fehlender oder unbekannter Schlüssel liefert 401 Unauthorized.
| Methode | Pfad | Zweck | Body | Antwort |
|---|---|---|---|---|
GET | /me | Testet die Verbindung. | - | { "id", "documentConfigurationId", "documentConfigurationName", "username" } |
POST | /hooks | Abonniert den Zap (REST-Hook). Die URL muss mit https://hooks.zapier.com/ beginnen, sonst 400. | { "hookUrl": "…" } | { "id" } |
DELETE | /hooks | Kündigt das Abonnement des Zaps. Das Ziel wird nur getrennt, wenn hookUrl der aktuell verbundene ist. | { "hookUrl": "…" } | leer |
GET | /documents/sample | Liefert bis zu drei kürzlich verarbeitete Dokumente des Dokumenttyps im Payload-Format. | - | Array von Payloads |
Zustellung: Wenn ein Dokument freigegeben wird, sendet AIDA einen HTTP POST mit dem Payload an den abonnierten Hook, mit Content-Type: application/json. Antwortet Zapier mit 410 Gone, trennt AIDA das Ziel.