Partner Development Guidelines
This page is relevant for POS providers who wish to be listed as partners.
If you're a point of sale provider developing an integration between your system and Apicbase, there are some implementation details that need to be followed before we can certify your solution.
These guidelines establish a quality standard that meets our customers' expectations for the reliability of the connection between their accounts and their POS systems. By meeting all requirements, we can ensure that your solution is fully compatible with Apicbase.
The completeness of your solution will be assessed by our integrations team. Having your integration be validated opens up possibilities for marketing and other types of partnerships.
- The application should NOT use any endpoints outside of the Sales scope to create entities such as Recipes, Ingredients or Menus.
- IF the application receives an error response from the Apicbase API at the moment of uploading either product or sales data, THEN the application must communicate clearly via the POS system’s user interface that an error occurred when connecting to Apicbase.
- The application should be able to refresh expired access tokens without the need for manual user intervention.
- The application should NOT refresh their access tokens before every API request. Refresh token requests must be kept under a reasonable limit (the recommended approach is to catch 401 Unauthorized error responses from the Apicbase API, refresh the access token and re-try with the same request).
Items and Groups Upload
- The application must upload all groups, items and modifiers for a single outlet in bulk, using a single API request.
PUT /analytics/generic_pos/product/endpoint should NOT be used to create or update multiple items, except for minor updates for a single item.
- To keep the product catalogues in sync between the POS system and Apicbase, the application should periodically and automatically make requests to the POST
/analytics/generic_pos/group_items/endpoint with the updated product catalogue.
- If periodic uploading of the product catalogue to Apicbase is not possible due to technical limitations, the application must perform a sync without user intervention before uploading sales data to ensure compatibility.
- The application should upload tickets to the
/analytics/generic_pos/sales/endpoint automatically, without requiring manual user intervention.
- If the application uploads tickets periodically in bulk, it should do so at least once a day.
- If the application uploads tickets automatically when they are created/closed/paid, it must not impact the functionality of the POS system, especially in cases where the Apicbase API returns an error response or the response is delayed.
- The application should upload sales data in chronological order, from the oldest ticket to the newest.
- The application should not upload tickets from a date earlier than a ticket that has already been uploaded to Apicbase.
- If an event occurs that prevents the application from uploading sales data for an extended period, then as soon as the issue is resolved, the application should automatically upload all tickets from the missed period.
- The application should not upload any newer tickets until the issue has been resolved.
All done? Welcome aboard!
Once you have completed the integration and verified that it is fully functional, you can contact [email protected] to schedule a quality assurance call.
If the integration meets our guidelines and requirements, we will provide guidance on the next steps for the partnership and release your application to our customer libraries.
Updated about 1 month ago