EDOOBOX DEVELOPERS OpenAPI 3.2.1

Eine API.
Ihre Möglichkeiten.

Verbinden Sie Angebote, Buchungen und Teilnehmende mit Ihren Anwendungen. Entdecken Sie die edoobox API v2 – bis ins einzelne Datenfeld.

Endpunkte entdecken Erste Anfrage

GET/v2/offer/list

# Host Ihrer edoobox Umgebung einsetzen
curl "$API_ORIGIN/v2/offer/list" \
  -H "Authorization: Bearer $TOKEN" \
  -H "edid: $EDID"

JWT + Kontokontext · JSON-Antwort

Vertrag und Antwortschema ansehen

LOSLEGEN

Von der Verbindung zur ersten Antwort

Zur ausführlichen Anleitung ↗

Umgebung festlegen
Setzen Sie API_ORIGIN auf den Host Ihrer edoobox Umgebung, ohne /v2. Die Endpunktpfade enthalten diesen Teil bereits.
Server in dieser Spezifikation
https://app2.edoobox.com
edoobox API
Verwenden Sie die Serverdefinition des jeweiligen Endpunkts und setzen Sie gegebenenfalls die dort dokumentierten Servervariablen ein.
Zugriff vorbereiten
Verwenden Sie einen gültigen Zugriffstoken und den passenden Kontokontext edid. Rechte und fachliche Prüfungen gelten für jeden Aufruf.
Authentifizierungs-Endpunkt →
Anfrage prüfen
Beginnen Sie mit einer als lesend gekennzeichneten Operation. Prüfen Sie HTTP-Status, Antwortinhalt und dokumentierte Fehler, bevor Sie das Ergebnis verarbeiten.
Angebotsliste lesen →

VERBINDUNG & VERTRAG

Was für jeden Aufruf wichtig ist

Authentifizierung mit Kontokontext

Geschützte Ressourcen verlangen überwiegend Authorization: Bearer <JWT> zusammen mit edid. Alternativ ist die bestehende Sitzung über das Cookie _edlogin und edid angegeben. Die Varianten sind Alternativen; innerhalb einer Variante müssen beide Bedingungen erfüllt sein.

edid ist der ausgewählte Kontext aus dem Login, keine Datenbank-ID. Einzelne Operationen sind öffentlich oder verwenden einen eigenen Trainer-Token. Massgebend ist die Authentifizierung auf der jeweiligen Endpunktseite.

Listen und Objekt-IDs

Verwenden Sie die undurchsichtigen v2-IDs aus API-Antworten, beispielsweise offer_012345abcdef_123456 als synthetisches Formatbeispiel. Numerische Datenbank-IDs sind kein Ersatz.

Viele Listen bieten fields, filter, limit und order. limit ist dort JSON mit start und reply. Parameter und zulässige Werte stehen pro Endpunkt; sie gelten nicht automatisch für jede Operation.

REFERENZ

Die passende Ressource finden

74 Bereiche · 893 Operationen

offer ↗booking ↗user ↗membershipplan ↗usermembership ↗invoice ↗

accounting

15 Operationen

POSTGETPUTDELETE

admin

27 Operationen

Eine API.Ihre Möglichkeiten.

Von der Verbindung zur ersten Antwort

Umgebung festlegen

Zugriff vorbereiten

Anfrage prüfen

Was für jeden Aufruf wichtig ist

Authentifizierung mit Kontokontext

Listen und Objekt-IDs

Die passende Ressource finden

accounting

admin

adminconfig

admission

admissioncontrol

ai

aiassistant

apiaccess

attendance

auth

auth2fa

automationrule

avataradmin

avataruser

barcode

booking

bookingqueue

bootstrap

cancellationcondition

category

charts

country

datastructure

date

deliverables

deliverablesgroup

design

dinaco

dunning

edsubscription

edtransaction

emailtemplate

exportmanager

fee

file

invoice

layout

membershipperiod

membershipplan

membershipredemption

note

offer

offerdef

offerlist

outbox

paymentsystem

permission

place

plugin

pricecategory

promotion

promotioncode

publicfile

pusherwss

question

questiongroup

room

saml

securefile

sendemail

settings

support

tag

task

template

text

trainer-course

transaction

user

userduplicate

usermembership

Eine API.
Ihre Möglichkeiten.