Hinzufügen und Aktualisieren von Gast-Daten (push)

Aufruf

Die Übertragung erfolgt über eine HTTP-POST-Anfrage an folgende URL:

https://gwatch.events/ext-api/push

Authentifizierung

Folgende Header müssen gesetzt werden:

• X-Api-key: Haupt-API-Schlüssel (Pflicht)
• X-Api-push: zusätzlicher Import-Schlüssel (optional, empfohlen – bitte separat anfordern)

Request-Body (Payload)

1. meta

Enthält Steuerparameter für das Importverhalten:

• failIfExists (Boolean): Gibt an, ob bei vorhandenem Ticketcode ein Fehler erzeugt wird oder die Daten aktualisiert werden.
• insertAs (Integer): Definiert den Status für neue Datensätze:
  • 1: bereits bestätigt
  • 2: zu bestätigen (erfordert spätere Rückmeldung durch den Gast)
  Hinweis: Wird nur bei neu angelegten Gästen berücksichtigt.

2. guests

Enthält ein Array mit bis zu 100 Gast-Datensätzen. Jeder Datensatz ist ein Key-Value-Objekt, basierend auf den Feldern aus /metadata.

Besonderheiten:

• Ticketcode: Fehlt er, wird ein neuer generiert. Ist er vorhanden, erfolgt eine Prüfung – abhängig von failIfExists.
• Gates: Falls im Metadata-Abschnitt gates enthalten sind, kann zusätzlich ein Array gates mit Gate-IDs gesetzt werden. Fehlen in diesem Array dem Gast bereits zugewiesene Gates, werden sie entfernt.

Beispiel-Request

{
  "meta": {
    "failIfExists": false,
    "insertAs": 2
  },
  "guests": [
    {
      "GUEST_FIRST_NAME": "Max",
      "GUEST_LAST_NAME": "Mustermann",
      "GUEST_EMAIL": "max@example.com",
      "GUEST_TICKET_CODE": "ABC123",
      "gates": [1, 3]
    }
  ]
}

Validierung

• HTTP 422: Bei formalen Fehlern im gesamten Request (z. B. ungültiges JSON).
• Einzelne Gast-Datensätze werden separat validiert – auch bei Fehlern wird der gesamte Vorgang nicht abgebrochen.

Response

Die Antwort gliedert sich in zwei Bereiche:

1. summary

• total: Anzahl der übergebenen Datensätze
• created: neu angelegte Gäste
• updated: aktualisierte Gäste
• failed: fehlerhafte Einträge

2. results

Gibt für jeden Datensatz an, ob die Verarbeitung erfolgreich war oder nicht.

HTTP-Statuscodes

• 200 OK: Alle Datensätze wurden erfolgreich verarbeitet.
• 207 Multi-Status: Einige Datensätze konnten nicht verarbeitet werden (Details in results).