Environment:
Skip to main content

Step-by-step Guide

Integrating with the Sibill APIs involves several steps.

  1. The first step is to test the integration in a test (or development) environment. In this environment, you need to register your company; simply follow the registration process.

  2. Once registration is complete, you can generate the token for your development-environment account yourself. From the newly created account, go to Settings → API Key and click Generate to create the token.

    You can see the steps just described in this video.

    The same page also contains two other essential pieces of information for testing the integration: the company ID of the newly created company and the link to the technical documentation.

    Important

    Copy the token immediately after generating it — once you leave the page it can no longer be retrieved and you'll need to generate a new one.

    • Missing permissions: if you don't see the API Key entry under Settings, it's because you don't have permission to access this area. To get it, ask a user in your company with Admin rights to grant it to you. To find out who that is, go to Settings → Team — there you'll find the list of users with the administrator permission. An administrator can manage other users' permissions by following the instructions in this video.

  3. Once you're satisfied with how the integration works in the development environment, you can generate the token for the production environment as well. Just follow the same process described above, in your company's production account.

During the test phase you can create, modify and delete resources. However, resources created in the test environment will NOT be visible in the production environment.

warning

The company created in test will NOT have the records and documents that are present in the production environment; this means the test environment will initially be empty. This is intentional in order to guarantee data privacy and isolate the test from the production environment.

info

The test environment is designed to allow you to test the integration without worrying about damaging the data present in the production environment, and to verify and correct any errors.