API-Referenz

Alle dokumentierten Schnittstellen im Überblick. Eine Einführung in die drei API-Typen und den API-Schlüssel finden Sie im Artikel API-Schnittstellen.

Public API

Abfrage allgemeiner Daten

• GETAbfrage der Standorte/externalBooking/getServicerGroups
• POSTAbfrage der Leistungen und Gruppen/externalBooking/calcGroups
• POSTBerechnung der Mitarbeiter zu Leistungen/externalBooking/calcServicers
• POSTAbfrage des Warenkorbs/externalBooking/getBasket
• POSTZusatzdienstleistungen für gewählte Leistungen abfragen/externalBooking/getDependencyServices
• POSTAbfrage von zusätzlichen Feldern (deprecated)/externalBooking/getAdditionalFields
• POSTMitarbeiterinformationsabfrage/externalBooking/getServicer
• POSTMitarbeitersuche mit Namen/externalBooking/servicerByName
• POSTPreisdetails für Leistung/externalBooking/getPricesForService
• POSTSchrittweisen Buchungsprozess abfragen/externalBooking/getPricesForService

Abfrage verfügbarer Uhrzeiten

• POSTVerfügbare Termine/externalBooking/calcAvailableAppointments
• POSTTerminzeiten (auch bereits belegte)/externalBooking/calcAppointmentTimes

Buchung

• POSTBuchung starten (alt)/newAppointment/bookAppointment
• POSTBuchung starten/newAppointment/bookAppointmentAPI
• POSTBuchungsstatus abfragen/externalBooking/getBookingInfo
• POSTAbfrage des Warenkorbs für eine Buchung/externalBooking/getBasketForAppointment
• POSTKundendaten zur Buchung hinzufügen/externalBooking/persistCustomerData
• POSTAbfrage Termin-spezifischer Felder/externalBooking/getFieldsForBooking
• POSTTerminspezifische Informationen speichern/externalBooking/persistBasicData
• POSTBuchungsabschluss/externalBooking/finalizeBooking

Newsletterregistrierung

• POSTNewsletterregistrierung/externalBooking/createCustomer

Gutscheinvalidierung

• POSTGutscheinrestwertabfrage/externalBooking/checkVoucher

Bewertungen

• POSTBewertungsabfrage/externalBooking/getValuations

Gutscheine

• GETAbfrage der verkaufbaren Gutscheine/externalBooking/getVouchers

Private API

Token

• GETToken erhalten/mobile/rest/1.0/init/initSession
• GETToken auslesen/mobile/rest/1.0/init/read
• GETSprache ändern/mobile/rest/1.0/init/switchLocale

Data

• GETNews/mobile/rest/1.0/data/news
• GETStandorte

Login

• POSTLogin/mobile/rest/1.0/login/login
• POSTLogin SHA-2/mobile/rest/1.0/login/loginDirect
• POSTLogout/mobile/rest/1.0/login/logout

Fragenkatalog

• GETFragenkatalog auslesen/mobile/rest/1.0/question/index
• GETFragenkatalog auslesen mit Infos/mobile/rest/1.0/question/index2
• POSTÜbergreifenden Fragenkatalog auslesen/mobile/rest/1.0/question/merged

Benutzerverwaltung

• POSTSimple Registrierung/mobile/rest/1.0/user/registration
• POSTRegistrierung/mobile/rest/1.0/user/registration2
• POSTRegistrierung bestätigen (optional)/mobile/rest/1.0/user/activateAccount
• POSTPasswort vergessen/mobile/rest/1.0/user/forgetPassword
• POSTPasswort neu setzen (optional)/mobile/rest/1.0/user/submitForgetPassword
• POSTPush ID speichern/mobile/rest/1.0/user/registerForNews

Profil

• POSTPasswort ändern/mobile/rest/1.0/mobileProfile/changePassword
• GETBenachrichtigungseinstellungen abfragen/mobile/rest/1.0/mobileProfile/notificationSettings
• POSTBenachrichtigungseinstellungen ändern/mobile/rest/1.0/mobileProfile/updateNotificationSettings
• GETZukünftige Terminliste/mobile/rest/1.0/myAppointments/list
• GETVergangene Termine/mobile/rest/1.0/myAppointments/pastAppointments
• POSTTermin absagen/mobile/rest/1.0/appointment/cancelAppointment
• POSTAccount löschen/mobile/rest/1.0/mobileProfile/deleteAccount
• GETProfilabfrage/mobile/rest/1.0/mobileProfile/getProfile
• POSTProfiländerung/mobile/rest/1.0/mobileProfile/updateProfile

Terminbuchung

• POSTMitarbeiter für Leistungen (deprecated)/mobile/rest/1.0/appointment/servicerCandidates
• POSTMitarbeiter für Leistungen/mobile/rest/1.0/appointment/servicerCandidates2
• POSTVerfügbare Tage/mobile/rest/1.0/appointment/dayCandidates
• POSTTagesabfrage/mobile/rest/1.0/appointment/dayCandidates2
• POSTTerminzeiten für einen Tag (deprecated)/mobile/rest/1.0/appointment/timeCandidates
• POSTTerminzeiten für einen Tag/mobile/rest/1.0/appointment/timeCandidates2
• POSTUhrzeit reservieren/mobile/rest/1.0/appointment/reserveAppointment
• POSTBuchung abschließen/mobile/rest/1.0/appointment/finalBookAppointment

Geschützte API

Dienstplanung

• GETArbeitszeiten abfragen/office/api/workingTimes
• GETArbeitszeiten erstellen/office/api/createWorkingTime
• GETArbeitszeiten ändern/office/api/updateWorkingTime
• GETArbeitszeiten löschen/office/api/deleteWorkingTime
• GETArbeitszeiten, Abwesenheiten und Notizen eines Mitarbeiters abrufen/office/api/dayData
• POSTMitarbeiter mit Pause blockieren/office/api/createBreak

Allgemein

• GETTerminänderung eines Tages abfragen/office/api/latestAppointments
• GETTermine für einen Tag abfragen/office/api/appointments
• GETDaten für einen einzelnen Termin abfragen/office/api/appointment
• GETTermine für einen Kunden abfragen/office/api/appointmentsForCustomer/38172646
• GETKundensuche nach Mobilnummer/office/api/customerForMobile
• GETKundenliste mit Mobilnummer/office/api/customersForMobile
• GETKundenabfrage/office/api/customers
• GETRechnungen abfragen/office/api/receipts
• GETProduktauflistung VK/office/api/productDefinitions
• GETProduktsuche/office/api/productDefinitionList
• GETLeistungsauflistung gruppiert nach Produktgruppe/office/api/serviceDefinitions
• GETLeistungsauflistung/office/api/serviceDefinitions
• GETGutscheinauflistung/office/api/voucherDefinitions
• GETMitarbeiter/office/api/employees
• GETKassenstandsabfrage/office/api/cashPosition
• POSTBestand an einem Verkaufsprodukt ändern/office/api/updateQuantity
• POSTKundentermin absagen/office/api/removeAppointment