app2email API Preise

Dokumentation

Setup-Dateien

Eine Setup-Datei enthält das gesamte Setup einer Integration als eine Textdatei. Laden Sie sie als Backup herunter, ändern Sie viele Dinge auf einmal, kopieren Sie ein Setup auf eine andere Nummer oder lassen Sie einen KI-Agenten alles über die API oder MCP einrichten. Jeder Upload wird zuerst geprüft und lässt sich rückgängig machen.

Eine Setup-Datei enthält alles, was Sie in einer Integration einrichten: die Einstellungen, die Leistungen und Mitarbeiter von Book-and-Pay, die Kategorien, Optionen und Produkte von Order-and-Pay, die Veranstaltungen, Termine und Ticketarten von Tickets-and-Pay sowie die Formulare und Automatisierungen von Submit-Info. Sie ist eine Textdatei, sodass Sie sie als Backup aufbewahren, in einem beliebigen Editor ändern, erneut hochladen oder auf eine andere Ihrer Nummern kopieren können.

Dieselbe Datei funktioniert an drei Stellen: im Dashboard, in der API und auf dem MCP-Server für KI-Agenten.

Im Dashboard

Jede Integration hat einen Abschnitt Setup-Datei:

IntegrationWo
Book-and-Paydie Registerkarte Übersicht, ganz unten
Order-and-Paydie Registerkarte Import und Export, ganz unten
Tickets-and-Paydie Registerkarte Einstellungen, ganz unten
Submit-Infodie Registerkarte Einstellungen, ganz unten

Nur der Inhaber und die Admins einer Nummer sehen ihn.

  1. 1. Herunterladen

    Herunterladen liefert das Setup als Datei .a2e.jsonl. Mit Bildern herunterladen liefert eine .zip mit derselben Datei und allen Bildern darin: ein vollständiges Offline-Backup, das Sie unverändert wieder hochladen können.

  2. 2. Ändern

    Öffnen Sie die Datei in einem Texteditor und ändern, ergänzen oder entfernen Sie Zeilen. Jede Zeile ist eine Sache: eine Leistung, ein Produkt, eine Veranstaltung. Eine Tabellenkalkulation ist nicht nötig.

  3. 3. Hochladen

    Datei hochladen prüft sie zuerst. Noch ändert sich nichts. Sie sehen jedes Problem mit seiner Zeilennummer und wie es zu beheben ist, oder was das Anwenden bewirken würde: wie viele Dinge neu, geändert oder entfernt würden, und welche.

  4. 4. Anwenden

    Anwenden führt genau die Änderungen aus, die die Prüfung gezeigt hat. Eine Prüfung bleibt 1 Stunde gültig.

  5. 5. Rückgängig machen

    Jedes Anwenden steht unter Letzte Änderungen per Setup-Datei. Rückgängig stellt alles wieder her, was dieses Anwenden geändert hat, 30 Tage lang, solange kein späteres Anwenden dieselbe Integration geändert hat. Machen Sie das spätere zuerst rückgängig.

Hinzufügen und ändern, oder genau wie die Datei machen

Wählen Sie vor dem Hochladen, was mit den Dingen geschieht, die die Datei nicht aufführt:

  • Hinzufügen und ändern (Standard): Die Zeilen in der Datei werden angelegt oder geändert, alles andere bleibt, wie es ist. Eine Datei mit nur fünf Zeilen ändert nur diese fünf Dinge.
  • Genau wie die Datei machen: Alles von derselben Art, was die Datei nicht aufführt, wird entfernt. Ein Produkt wird archiviert, nie gelöscht. Die Prüfung listet jede Entfernung auf, bevor Sie anwenden.

Auf eine andere Nummer kopieren

Wenn Sie Inhaber oder Admin von mehr als einer Nummer sind, kopiert Auf eine andere Nummer kopieren das Setup einer Integration von der Nummer, auf der Sie sind, auf eine andere: eine zweite Filiale, eine Testnummer oder eine Vorlage, die Sie jedem neuen Shop geben.

Die Kopie wird zuerst auf der anderen Nummer geprüft und zeigt, was sie dort ändern würde. Jetzt kopieren wendet sie an. Die Bilder werden mitkopiert. Um eine Kopie rückgängig zu machen, öffnen Sie dieselbe Integration auf der anderen Nummer: Die Kopie steht dort unter Letzte Änderungen.

Note

Die Webadresse von Book-and-Pay, Order-and-Pay und Tickets-and-Pay gehört zu genau einer Nummer und wird nie kopiert. Legen Sie die Adresse der anderen Nummer in deren eigenem Dashboard fest.

Was eine Setup-Datei enthält

IntegrationZeilen
Book-and-Paybooking.settings (eine Zeile pro Abschnitt: Zeiten, Web, Marke, Nachrichten ...), booking.service, booking.provider (Mitarbeiter)
Order-and-Payshop.settings (eine Zeile pro Abschnitt, einschließlich des Aussehens der Bestellseite), shop.category, shop.option_group, shop.item (mit Varianten und Bildern)
Tickets-and-Paytickets.settings (eine Zeile pro Abschnitt; wa_templates ist Ihr eigener Wortlaut der WhatsApp-Nachrichten), tickets.chart (gespeicherte Sitzpläne), tickets.event (mit Terminen, Ticketarten, gemeinsamen Limits, Bildern und Sitzplan), tickets.promo
Submit-Infosubmit.settings, submit.list, submit.connection, submit.form, submit.automation
Alleasset: ein Bild, benannt durch die Zeilen, die es verwenden

Nie in einer Datei

  • Geheimnisse: Zahlungsschlüssel, Verbindungspasswörter und Tokens. Ein gespeichertes Geheimnis bleibt, wie es ist.
  • Eine Integration einschalten. Das tut eine Datei nie, und eine Datei veröffentlicht, storniert oder löscht nie eine Veranstaltung mit Tickets.
  • Was Kunden getan haben: Buchungen, Bestellungen, verkaufte Tickets, Einsendungen, Kunden, Zahlungen.
  • Teammitglieder und Mitarbeiter-Logins.
  • Lagerbestände von Order-and-Pay, es sei denn, Sie setzen das Häkchen bei Lagerbestände auch aus der Datei setzen. Ohne es kann eine Datei, die Sie morgens exportiert haben, die Verkäufe des Tages nicht rückgängig machen.

Das Format

Eine Setup-Datei ist JSON Lines: ein JSON-Objekt pro Zeile. Die erste Zeile sagt, was die Datei ist; jede andere Zeile ist ein Datensatz mit einem type und einem key. Der Schlüssel findet denselben Datensatz beim nächsten Mal wieder: die ID einer Leistung, die SKU eines Produkts, die Adresse einer Veranstaltung.

{"type":"a2e.setup","version":1,"products":["booking"]}
{"type":"booking.service","key":"haircut","name":"Haircut","duration_min":30,"price":"$25","price_amount":25}
{"type":"booking.service","key":"beard","name":"Beard trim","duration_min":15,"price":"$12","price_amount":12}
{"type":"booking.provider","key":"sam","name":"Sam","services":["haircut","beard"]}

Die Reihenfolge der Zeilen spielt keine Rolle. Preise bei Book-and-Pay sind Beträge (25 ist 25,00, price ist die daneben angezeigte Bezeichnung); Preise bei Order-and-Pay und Tickets-and-Pay stehen in der kleinsten Einheit der Währung (1250 ist 12,50). Die genauen Felder jeder Zeile stehen in der Anleitung der API (GET /v1/{number}/setup/guide).

Bilder

Ein Datensatz benennt ein Bild über den Schlüssel einer asset-Zeile. Das Bild stammt aus einer dieser Quellen:

  • url: eine https://-Adresse, die wir abrufen.
  • data: das Bild selbst, base64.
  • file: ein Pfad innerhalb der hochgeladenen .zip.
  • sha256: ein Bild, das diese Nummer bereits hat.

Ein Export schreibt die öffentliche Adresse jedes Bildes. Ein Bild ohne öffentliche Adresse, etwa das Grundrissbild hinter einem Sitzplan, erhält einen signierten Link, der 7 Tage funktioniert, sodass eine auf eine andere Nummer kopierte Datei es weiterhin enthält.

{"type":"asset","key":"classic-photo","url":"https://example.com/classic.jpg"}
{"type":"shop.item","key":"BURGER-CLASSIC","name":"Classic burger","category":"burgers","price":1250,"images":["classic-photo"]}

Bilder sind PNG, JPEG oder WEBP, höchstens 5 MB je Bild. Wo eine Integration es braucht, wird ein Bild verkleinert oder in ein JPEG umgewandelt: ein Logo bei Book-and-Pay auf 300 KB, ein Bild bei Tickets-and-Pay auf 1 MB.

Für KI-Agenten und die API

Ein Agent richtet eine ganze Integration in einem geprüften Schritt ein statt in Dutzenden von Aufrufen. Der MCP-Server https://api.app2email.com/mcp/setup hat diese Tools: get_setup_guide, export_setup, check_setup, apply_setup, upload_setup_asset, list_setup_jobs, get_setup_job und undo_setup. Dieselben Aufrufe gibt es in der API:

AufrufWas er tut
GET /v1/{number}/setup/guidejeden Datensatztyp, seine Felder und Limits, mit Beispielen. Agenten lesen ihn zuerst
GET /v1/{number}/setup/exportdie aktuelle Datei: format=jsonl, zip oder json
POST /v1/{number}/setup/checkprüft eine Datei und ändert nichts: Probleme nach Zeile, den Plan, eine check_id
POST /v1/{number}/setup/applywendet eine Prüfung an: {"check_id": 123}
POST /v1/{number}/setup/assetsspeichert ein Bild für 7 Tage und antwortet mit seinem sha256
GET /v1/{number}/setup/jobsdie letzten Prüfungen, Anwendungen und Rückgängigmachungen
POST /v1/{number}/setup/jobs/{id}/undostellt wieder her, was ein Anwenden geändert hat

Der Schlüssel braucht die eigene Berechtigung der Integration: bookings:manage, orders:manage, tickets:manage oder submissions:manage. Ein Sandbox-Schlüssel darf exportieren und prüfen, aber nicht anwenden.

Tip

Der übliche Ablauf für einen Agenten: die Anleitung lesen, die aktuelle Datei exportieren, einige Zeilen ändern, prüfen, beheben, was die Prüfung meldet, und dann den Benutzer fragen, bevor die check_id angewendet wird.

Limits

WasLimit
Eine Datei20 MB Text, 50.000 Zeilen (im Dashboard ein Upload von höchstens 19 MB)
Eine Anfrage mit Bildern darin60 MB über die API
Ein Bild5 MB
Per Adresse abgerufene Bilder100 pro Upload; Order-and-Pay ruft Produktbilder im Hintergrund innerhalb von Minuten ab
Große Dateienmehr als 1.000 Datensätze werden im Hintergrund geprüft und angewendet; das Dashboard wartet von selbst darauf
Eine Prüfungkann innerhalb von 1 Stunde angewendet werden, einmal
Rückgängig machen30 Tage