Applies To Version 1.10 or later
All IBSS cloud deployments are specific. Providing access to your IBSS API for a 3rd party system is provided by an Application User connection. Each Application User will be assigned specific access rights to the entities that need to be accessed by the 3rd party system, and is part of a commercial agreement.
Setup
ICONICS will setup the Application User in your IBSS deployment in Azure, the <<application-user-key>> will be provided once this is setup.
Authentication
The Application User will have a unique <<application-user-key>>. Any call made by the 3rd party system to the IBSS API will have to have the following header
1 Authorization: apikey <<application-user-key>>If the Application User is successfully authenticated, and has the appropriate access rights for the request (GET, PUT, etc.) the request is executed and the results will be returned to the calling system.
Documentation
The IBSS API is documented and can be tested from within the Swagger web pages. https://api.ibss.[[customer-environment]].iconics.cloud/swagger/index.html
Server-driven pagination
To improve loading large data, IBSS API uses pagination to load the data incrementally. This improves the response times and the user experience. For this, we use the @odata.nextLink property on the response with the included $skiptoken to return the page size of top 25 results by default.
While accessing the IBSS API pagination, use the Next and Previous tokens for the following pages:
- /v2/{nodeid}/bookingparties
- /v2/{nodeid}/bookings/my-bookings
- /v2/{nodeid}/bookings
- /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-supplier*
- /v2/{nodeid}/visits*
- /v2/{nodeid}/bookingpolicies*
*To be available in app version 2023.02
Read more on paging in the Microsoft official guidance: Use $skiptoken for server side paging - OData | Microsoft Learn