Alle IBSS Cloud-Bereitstellungen sind spezifisch. Der Zugriff auf Ihre IBSS -API für ein Drittanbietersystem erfolgt über eine Anwendungsbenutzerverbindung . Jedem Anwendungsbenutzer werden spezifische Zugriffsrechte für die Entitäten zugewiesen, auf die das Drittanbietersystem zugreifen muss. Dies ist Teil einer kommerziellen Vereinbarung.
Aufstellen
ICONICS richtet den Anwendungsbenutzer in Ihrer IBSS -Bereitstellung in Azure ein. Der <<Anwendungsbenutzerschlüssel>> wird bereitgestellt, sobald dies eingerichtet ist.
Authentifizierung
Der Anwendungsbenutzer erhält einen eindeutigen <<application-user-key>>. Jeder Aufruf der IBSS -API durch das Drittsystem muss den folgenden Header enthalten:
1 Authorization: apikey <<application-user-key>>Wenn der Anwendungsbenutzer erfolgreich authentifiziert wurde und über die entsprechenden Zugriffsrechte für die Anfrage (GET, PUT usw.) verfügt, wird die Anfrage ausgeführt und die Ergebnisse werden an das aufrufende System zurückgegeben.
Dokumentation
Die IBSS API ist dokumentiert und kann auf den Swagger-Webseiten getestet werden. https://api.ibss.[[customer-environment]].iconics.cloud/swagger/index.html
Servergesteuerte Paginierung
Um das Laden großer Datenmengen zu verbessern, verwendet IBSS API die Paginierung, um die Daten inkrementell zu laden. Dies verbessert die Reaktionszeiten und das Benutzererlebnis. Dazu verwenden wir die Eigenschaft @odata.nextLink in der Antwort mit dem enthaltenen $skiptoken, um standardmäßig die Seitengröße der Top 25-Ergebnisse zurückzugeben.
Verwenden Sie beim Zugriff auf die IBSS -API-Paginierung die Token „Weiter“ und „Zurück“ für die folgenden Seiten:
- /v2/{nodeid}/Buchungspartys
- /v2/{nodeid}/bookings/meine-buchungen
- /v2/{nodeid}/Buchungen
- /v2/{nodeid}/costcodes
- /v2/{nodeid}/catering-menu*
- /v2/{nodeid}/Catering-Menuitem*
- /v2/{nodeid}/catering-order*
- /v2/{nodeid}/catering-order-policy*
- /v2/{nodeid}/catering-restriction*
- /v2/{nodeid}/catering-lieferant*
- /v2/{nodeid}/Besuche*
- /v2/{nodeid}/bookingpolicies*
*Verfügbar in der App-Version 2023.02
Weitere Informationen zum Paging finden Sie im offiziellen Leitfaden von Microsoft: Verwenden von $skiptoken für serverseitiges Paging – OData | Microsoft Learn