Direkt zum Hauptinhalt

Abruf der Metadaten (metadata)

Swagger-Referenz: Operation und Antwortschema öffnen.

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

curl --request GET 'https://gwatch.events/ext-api/metadata' \
  --header 'x-api-key: IHR_HAUPTSCHLUESSEL' \
  --header 'Accept: application/json'

Benötigt werden der Hauptschlüssel und gegebenenfalls die Freigabe Ihrer IP-Adresse. Ein Flavor- oder Import-Schlüssel ist für diesen Aufruf nicht erforderlich.

Aufbau 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 freigegebenen Gates mit id und name. Es kann leer sein.

Die folgende gültige JSON-Darstellung ist ein gekürztes Beispiel nach den Swagger-Modellen mit einer Auswahl von Feldern. Beispielgrenzen sind keine festen Vorgaben für Ihre Veranstaltung:

{
  "event": {
    "name": "IT seminar",
    "date": "2025-05-31",
    "defaultTicketCodeLength": 10,
    "locales": [
      "de",
      "en"
    ]
  },
  "guest": [
    {
      "key": "GUEST_TICKET_CODE",
      "name": "Ticket code",
      "type": "singleLineText",
      "restrictions": {
        "nullable": false,
        "unique": true,
        "min": 6,
        "max": 12
      }
    },
    {
      "key": "GUEST_LOCALE",
      "name": "Locale",
      "type": "list",
      "items": [
        {
          "key": "de",
          "value": "Deutsch"
        },
        {
          "key": "en",
          "value": "English"
        }
      ],
      "restrictions": {
        "nullable": false
      }
    },
    {
      "key": "GUEST_NAME",
      "name": "Name",
      "type": "singleLineText",
      "restrictions": {
        "max": 65535
      }
    }
  ],
  "gates": [
    {
      "id": 6398,
      "name": "Sicherheit von Websites"
    },
    {
      "id": 6399,
      "name": "Anti-Viren Software aktuell"
    }
  ]
}

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 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.

Ergänzung zum aktuellen Portal: Der Feldtyp image ist in der abgerufenen Swagger-Feldliste noch nicht enthalten. Verwenden Sie ihn nur, wenn die tatsächliche metadata-Antwort ihn für Ihre Veranstaltung liefert. 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:

{
  "key": "GUEST_FOOD",
  "name": "Food",
  "type": "list",
  "items": [
    {
      "key": "ID_164h656yn",
      "values": {
        "de": "Keine Einschränkungen",
        "en": "No restrictions"
      }
    },
    {
      "key": "ID_6rkyfap8y",
      "values": {
        "de": "Vegetarisch",
        "en": "Veggie"
      }
    },
    {
      "key": "ID_ncg2151l7",
      "values": {
        "de": "Vegan",
        "en": "Vegan"
      }
    }
  ],
  "restrictions": {
    "nullable": true
  }
}

Beim Schreiben verwenden Sie hier beispielsweise "GUEST_FOOD": "ID_6rkyfap8y" für die vegetarische Auswahl. 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.

nach oben