Getting started

 

The Sandbox environment
The SIBS API Market Sandbox is a Developers Portal environment where you can access technical documentation and test the available APIs with dummy data in order to understand if it fits your needs.

How to Register in Sandbox
From the Welcome Page: In the Register Menu, just click in “Register to Sandbox”, and fill the data.
From the Sandbox: In the Login Menu, just click in “Create new account”, and fill the data.

You will receive an email to activate your account. Sign up now to create an account and get started. It is free to join.

API Documentation
In the API Documentation Menu you can find all the available APIs, organized in Products. Each product has one or more Plans that you can subscribe. To subscribe to a Plan you must be Logged in. By clicking on any API you can have access to its technical documentation. The documentation includes a short description of the API, the Endpoints for integration, Paths, Parameters definition and Examples in different languages eg. cURL, Ruby, Python, PHP, Java, etc.

Open API
By clicking on the Open API menu, you can have access to the API’s yaml.

Register an Application
Before you can use an API you have to register your application in the Sandbox. Go to menu APPS->Create New App. When you register an application, the application is assigned a unique client ID and client secret. You must use the client ID and client Secret on the call to the API to identify your application.

Choose the APIs to integrate
After you have successfully registered your application, you can now browse the available Products (in the API Documentation menu) and find the APIs you want to test and integrate.
The Products are groups of APIs that you can subscribe according to the defined Plans.

Subscribe to a Plan
Now that you have identified the Product that includes the APIs you want to use, you have to subscribe to a Plan. The Plan defines the number of API calls that your application can make, and the usage cost. Some plans are free and no approval is required, some require approval, and some require approval and a monthly subscription. Think about what you need and choose the most suitable plan. To subscribe a Plan, go to API Documentation Menu, select the Product you want, and press the “Subscribe” button on the Plan that best suits your needs.

Test the APIs with dummy data (Sandbox)
Now that you have subscribed a Plan of an API Product, you can start testing all the APIs included in the Product. The test Server of your Application can now call the APIs endpoints to test them.
The SIBS API Market Sandbox will reply with static test data to your calls.

Help options
The Support menu has the available support tools that you can use in this environment.

Forums
There are Forums, available for you to post functional or technical questions, discuss implementation issues that resulted from your integration experience.
Besides the community contributions, SIBS has Forum Moderators that can also answer questions or clarify some information posted in the forums.

FAQ
There is also a list of Frequently Asked Questions that may help you finding answers to some of the most common questions and doubts, or simply discover how to use features you have not yet come across with.