API Connect uses a concept of application. Attached to an organization having a Sis ID contract, an application represents a context of usage for APIs within the Sis Inside scope.
An application also includes:
- Authentication methods and credentials;
- A subscription to a plan associated with a bitrating limitation.
It is mandatory to have an application to trigger calls on Sis Inside APIs. Applications can be used to distinguish API usage contexts, integration origin or sub-entities within a given client organization.
API Connect applications creation
To start using Sis Inside APIs, you need to have at least one application created. Hit the APPS section and create your first application. Choose a meaningful application name like "ERP Name Version X" for instance or "Client Name for this use case"
Note: It is important that you correctly retrieve and safely store your credentials as the secret is provided only once.
API plan subscription
A subscription to any plan is mandatory to use the API. You can select either:
- Discovery plan for immediate access and discovery purposes;
- Standard plan for production like conditions and normal usage. An approval delay of be up to one day applies.
Once you have created an application and selected your plan, you are ready to go using our Sis Inside API. Explore the API documentation to get to know which API to use from the "API Products" section.
API Connect applications management
Once created, an application can be managed with the following options:
- Edit an application name from the application page, right hand top menu;
- Verify API secret, generate new credentials or API secret, change application plan subscribed from the "Subscription" tab;
- Access usage metrics from the "Dashboard" tab;
- Review activity from the "Notification" tab.