Abruf der Metadaten (metadata)

Worum es geht

metadata beschreibt die Veranstaltung und die verfügbaren Eingabefelder für push. Rufen Sie diese Angaben vor der Einrichtung eines Imports ab und prüfen Sie sie erneut, wenn die Veranstaltungskonfiguration geändert wurde.

Aufruf

Der

curl Abruf--request derGET Metadaten erfolgt über eine HTTP-GET-Anfrage an folgende URL:

'https://gwatch.events/ext-api/metadatametadata' \ --header 'X-Api-key: IHR_HAUPTSCHLUESSEL' \ --header 'Accept: application/json'

ZurBenötigt Authentifizierung musswerden der API-Hauptschlüssel imund Request-Header unter dem Schlüssel X-API-key mitgesendet werden. Kanngegebenenfalls die AuthentifizierungFreigabe Ihrer IP-Adresse. Ein Flavor- oder Import-Schlüssel ist für diesen Aufruf nicht erfolgreich durchgeführt werden kommt es zu einem HTTP 401 Fehler.erforderlich.

StrukturAufbau der Antwort

Die Antwort enthält direkt die Bereiche event, guest und gates, ohne zusätzliches error-Feld.

Bereich Inhalt event Veranstaltungsname, Datum, Standardlänge automatisch erzeugter Ticketcodes und verfügbare Sprachen. guest Array der importierbaren Felder mit key, name, type und gegebenenfalls restrictions oder items. gates Array der für die API istfreigegebenen in drei logische Bereiche gegliedert:

1. Veranstaltungsinformationen

Dieser Abschnitt enthält allgemeine Informationen zur Veranstaltung. Besonders wichtig ist hier der Eintrag zur Standardlänge des Ticketcodes. Dieser Wert ist beim Hinzufügen neuer Gäste relevant, um sicherzustellen, dass keine KonflikteGates mit bestehendenid Codesund entstehen.name. Es kann leer sein.

Die folgende gültige JSON-Darstellung ist ein längerergekürztes oder kürzerer Code verwendet werden, sofern er eindeutig ist.

Zusätzlich werden die in der Veranstaltung verfügbaren SprachenBeispiel mitgeliefert.mit Dieseeiner Informationen dienen dazu, beim Erstellen oder AktualisierenAuswahl von GästenFeldern dieund passendefiktiven Sprache zu wählen.

Beispiel:
Werten:

{
  "event": {
    "name": "IT-Seminar"Forum",
    "date": "2025-05-31"2026-10-15",
    "defaultTicketCodeLength": 10,
    "locales": [
            "de", "en"
        ]
  },

2. Verfügbare Felder für Gäste

In diesem Abschnitt werden alle Felder aufgeführt, die beim Hinzufügen oder Bearbeiten von Gästen verwendet werden können. Enthält ein Feld spezifische Restriktionen, so sind diese im jeweiligen Feld mit angegeben. Wenn in den Restriktionen "nullable": false angegeben ist, bedeutet dies, dass das Feld beim Einfügen oder Bearbeiten nicht mit einem Nullwert übergeben werden darf. Sind für das Feld keine Daten vorhanden, kann es aber einfach weggelassen werden. 

Jedes Feld enthält mindestens folgende Informationen:

key: Hier findet sich der Schlüssel des Feldes, welcher zum Hinzufügen und Bearbeiten genutzt werden muss. name: Dieser Name dient zur Kommunkation mit dem Teilnehmermanagement, damit alle wissen um welches Feld es sich handelt. type: Der Typ des Feldes, welche bestimmte Validierungsregeln impliziert.

multiLineText: Text, der Zeilenumbrüche enthalten darf. singleLineText: Text, der keine Zeilenumbrüche enthalten darf. email: Der Inhalt muss eine formal gültige E-Mail-Adresse sein. url: Der Inhalt muss eine formal gültige URL sein. numeric: Der Inhalt muss eine formal gültige Zahl im "Decimal Point Notation"-Format sein. integer: Der Inhalt muss eine formal gültige Ganzzahl sein. boolean: Der Inhalt kann "Yes", "No", 1, 0, true oder false sein. date: Format muss YYYY-MM-DD sein, z. B. 2025-04-08. dateTime: Format muss YYYY-MM-DDTHH:MM:SS sein, z. B. 2025-04-08T14:38:14. Zeitzonenangaben werden nicht verwendet. image: Der Wert wird als src URI übergeben, z.B. für ein PNG im Format: "data:image/png;base64,[BASE64 encoded image]". Zusätzlich werden die maximale Breite und Höhe in den Restriktionen angegeben. Ist das Bild zu groß, wird es beim import unter Einhaltung der Aspekt Ratio angepasst. list: Die möglichen Optionen werden als Key-Value-Paare angegeben. Beim Hinzufügen oder Bearbeiten von Gästen ist der Key zu verwenden, bei der Abfrage wird die lokalisierte Value zurückgegeben (abhängig von der gewählten Sprache).

Beispiel:

"guest": [
    {
      "key": "GUEST_TICKET_CODE",
      "name": "Ticket code",
      "type": "singleLineText",
      "restrictions": {
          "nullable": falsefalse, "unique": true, "min": 4, "max": 128
      }128}
    },
    {
      "key": "GUEST_LOCALE",
      "name": "Locale",
      "type": "list",
      "items": [
          {
              "key": "de", "value": "Deutsch"}, {"key": "en", "value": "Englisch"}
      ],
      "restrictions": {
          "nullable": false
      }false}
    },
    {
      "key": "GUEST_DINNER"GUEST_FIRST_NAME",
      "name": "Teilnahme am Abendessen"Vorname",
      "type": "boolean"
  },
  {
      "key": "GUEST_COMPANY_LOGO",
      "name": "Firmenlogo",
      "type": "image"singleLineText",
      "restrictions": {
          "maxWidth"max": 1024,
          "maxHeight": 51265535}
    }
  }],
  . . . .
}

3. Gates (Zugangsbereiche)

Der dritte Bereich enthält Informationen zu sogenannten Gates. Diese abstrakten Einheiten können verschiedene Bedeutung haben – zum Beispiel Veranstaltungstage, Sessions, Vorträge oder anderweitig geschützte Bereiche.

Diese Informationen dienen dazu, Gästen beim Erstellen oder Bearbeiten bestimmte Gates zuzuordnen. Eine detaillierte Verwendung wird im Abschnitt zum pull-Aufruf erläutert.

Beispiel:

"gates:gates": [
    {
        "id": 6398, "name": "SicherheitWorkshop"}]
}

Feldschlüssel und Einschränkungen

key wird beim Schreiben unverändert als JSON-Schlüssel verwendet. Groß-/Kleinschreibung beachten. name ist die lesbare Bezeichnung zur Abstimmung mit dem Teilnehmermanagement. type bestimmt das vorgesehene Eingabeformat. restrictions beschreibt zusätzliche Grenzen, etwa min, max, nullable, unique, maxWidth oder maxHeight.

nullable: false bedeutet: Wenn Sie das Feld senden, darf sein Wert nicht null sein. Das ist keine generelle Pflicht, das Feld in jedem Datensatz zu senden. Weggelassene Felder werden beim Aktualisieren nicht gezielt überschrieben; bei neuen Gästen greifen die jeweiligen Vorgaben beziehungsweise Standardwerte.

defaultTicketCodeLength ist die Standardlänge generierter Codes. Eigene Codes können davon abweichen, müssen aber die Restriktionen von Websites"GUEST_TICKET_CODE }einhalten. Senden Sie Ticketcodes als Zeichenfolge, damit führende Nullen erhalten bleiben.

Zu den Standardfeldern gehören GUEST_TICKET_CODE, GUEST_LOGIN, GUEST_PASSWORD, GUEST_LOCALE, GUEST_ACTIVE, GUEST_VALID_FROM und GUEST_VALID_TO. Weitere Gästefelder erscheinen nur bei entsprechender API-Freigabe. Verwenden Sie die tatsächlich gelieferte Feldliste.

Eingabeformate

Typ Empfohlener JSON-Wert singleLineText Zeichenfolge ohne Zeilenumbruch. multiLineText Zeichenfolge; Zeilenumbrüche in JSON als \n. email Formal gültige E-Mail-Adresse. url Vollständige gültige URL. numeric Zahl mit Dezimalpunkt, beispielsweise 12.5. integer Ganzzahl, beispielsweise 3. boolean JSON-Werte true oder false. Verlassen Sie sich nicht auf lokalisierte Zeichenfolgen wie Ja oder Nein. date Zeichenfolge im Format YYYY-MM-DD. dateTime Zeichenfolge im Format YYYY-MM-DDTHH:MM:SS. Die verwendete Portal-Zeitzone vor der Anbindung abstimmen. list Einen der unter items gelieferten Schlüssel verwenden. image Bild als eingebettete Data-URI, beispielsweise mit dem Präfix data:image/png;base64, und anschließendem Base64-Bildinhalt.

Bildfelder enthalten Größenangaben in den Restriktionen. Die Bildverarbeitung kann zu große Bilder beim Speichern proportional verkleinern. Eine gewöhnliche externe Bild-URL ist nicht das hier beschriebene Importformat.

Listen mit mehreren Sprachen

Bei benutzerdefinierten Listen kann ein Eintrag statt value eine sprachabhängige Zuordnung values enthalten:

{
  "id"key": 6399,"GUEST_CATEGORY",
  "name": "Anti-VirenKategorie",
  Software"type": aktuell""list",
  "items": [
    {"key": "vip", "values": {"de": "Ehrengast", "en": "VIP guest"}},
    .{"key": ."regular", ."values": .{"de": "Teilnehmer", "en": "Participant"}}
  ]
}

Beim Schreiben verwenden Sie hier "GUEST_CATEGORY": "vip". Die sichtbare Bezeichnung wird nicht als Eingabeschlüssel verwendet. Der Feldname ist beispielhaft und muss in Ihren Metadaten tatsächlich vorkommen.

Gates verwenden

Gates können Sessions, Veranstaltungstage oder andere Zugangsbereiche darstellen. Nur die unter gates aufgeführten IDs sind für die API-Zuweisung freigegeben. Wie Sie eine Gate-Auswahl übermitteln und was beim Weglassen oder Leeren passiert, beschreibt push.

Typische Probleme

Problem Prüfung HTTP 401 Hauptschlüssel, Veranstaltung und allgemeinen IP-Filter prüfen. Archivierte Veranstaltungen sind ausgeschlossen. Ein Gästefeld fehlt API-Freigabe des Feldes prüfen lassen. Ein Gate fehlt API-Freigabe des Gates prüfen lassen. Ausgabefeld aus pull ist hier nicht enthalten Lesefelder und Eingabeschlüssel sind getrennte Konfigurationen. Zuordnung vereinbaren.

Weiter: Gästeliste abrufen.
Zurück: Übersicht.