Introduction
This is a short how-to guide on how to set up a client so they can begin an API integration and what information should be shared with the client once the configuration is done.
Recommending an API integration is a good choice if the client has the necessary development resources, if we do not offer a 3party integration with their POS system or if the client has some complex needs that our other integrations can not accommodate.
Prerequisites
Have user-role of regional supervisor or administrator
Enable the setting "multi cash registers" in General Settings.
Only recommend an API integration to a client if they understand it requires development resources on their side. Have them include a technical resource in meetings leading up to the decision that can confirm that building an API integration is actually an option for them.
Configure integration settings for API.
NB: You must be inside the client's account when you enable these settings. In case the options below are not visual contact the SameSystem support team.
Navigate to General Settings. Inside the General settings menu under the General tab enable the setting “Enable API”. Click save.
Create an API user
The next step is now to create a new user that has the only purpose to have the API access connected to them. It is idea to name it "API user" so it is easy to find later on. Alternative, enable access for an existing user. This is how it is done:
Navigate to Users. Inside the user-menu select Create User. Once the user is created and named as suggested navigate to the tab "security" and enable the advanced setting "API Access".
Once this is done copy the CTX token within the URL as this should be shared with the client to allow him to send and receive data through the SameSystem API.
Share User Credentials, CTX Token, and documentation link with Client
Now that all settings have been configured in Samesystem the last step is to inform the client that the API access has been configured. Together with this message, the client would also need the following:
CTX Token: ie c123d45678
API user email: "john.doe@mail.dk",
API user password": "testing",
API documentation: https://samesystemapiv1.docs.apiary.io
The API documentation contains a detailed and developer focussed description of how to get access to the API and how to import and export data via the API.
Now all the steps that are needed to give the client access are completed and the client can start to build their API integration with SameSystem.
Staging/Testing environment
If the client also requires a staging/testing environment the above user configurations also need to be done for the specific staging environment. The following staging environments are available in Samesystem:
NB: Building an API integration is a task handled by the customer's development team. We do not help with the actual integration besides giving them access to the API, configuring the settings in SameSystem, and sharing documentation and best practices.