API – Getting started: authorization & API credentials

API stands for 'application program interface'.
It is a set of routines, protocols, and tools for building applications or programs to interact with your POS account.
In other words, it enables you to extend the features of your POS solution to better suit your needs.

Here are some examples of what you can do with the API:
– Sync your internet shop with your brick-and-mortar store,
– Send email or SMS campaigns to your customers,
– Create custom invoice templates,
– Link your POS account with shipping solutions or inventory software,
– Automate your pricing and discount policy (according to your customer groups, items purchased…),
– Connect your restaurant self-ordering kiosks,
– Enable online booking from your website,
– Send surveys to your customers,
– Publish your product catalog on different marketplaces,
– and much more ...

The only limit is your imagination.

You can consult the different resources of the API at the following address:


by replacing {my_account} with your account name.

Hiboutik allows both Basic Authentication and the OAuth2 protocol to grant access to the API.

Basic authentication

For this method you simply provide a username (email) and an API key to prove your authentication.
You can find them in Settings/API.
Your authorization is linked to your user’s access rights configured in Settings/Users/Access management.
If you reset the API key of a user (Settings/Users/Users), you will remove authentication and deny entry to any system attempting to use the revoked key.

Use basic authentication to extend your POS capabilities in a simple but effective way.

Oauth authentication

Oauth is an open standard for access delegation, commonly used as a way for you to grant websites or applications access to your account information without giving them your passwords.
In this approach, you log into your account, accept an app, and then let the app and your account exchange information to grant access.
The authorization has a limited scope (what the app can access) and age of validity.

Use Oauth authentication to develop an application that could be used by others accounts.

Envoyez nous un message

Cliquez ici

  • FR +33 (0)1 48 78 40 06
  • FR +41 (0)21 519 00 17
  • FR +32 (0)2 318 82 77
  • FR +34 (0)912 69 39 94