How to Start

Now that you understand what PIER {Labs} is and how it works, the next step is to gain access to the API Sandbox environment to start developing your applications. This step is quite simple and intuitive, but we will guide you in this task!

Note: Remember that you do not need a User Account to just explore the API!

 

Step 1 - Creating the Application

Once you are a registered user and logged into the platform, notice that the top bar of the site undergoes a change: you can now see the " Developer " tab. This is where you will register and manage all of your applications that use PIER {Labs}.

By clicking"My Applications", under the "Developer" menu, you will be redirected to the PIER {Labs} application management page.
It can also be accessed directly through the following link: https://pierlabs.io/api-portal/en/myapps .
In it, you have the option to access details of your applications, if any, or create new ones.

To create a new application, simply click the " Create Application " button or navigate to the following link: https://pierlabs.io/api-portal/en/myapps/new.

Once on the Application Creation page, simply fill in the data for the application you want to develop and click theCreate"button.

Once this is done, you will be redirected back to the My Apps screen, however, your application will now appear on this screen.

Whenever you create a new application, it will appear on the "My Applications"page.

 

Step 2 - Application access codes

After the previous step, you are now ready to use the PIER {Labs} API to develop your newly registered application. However, for it to work properly, you will need to have two codes: the "Client ID" and the "Access Token" of your application.

The "Client ID" always appears on the "My Applications". Note that there are two codes in the same column, one being the "Client ID" and the second the "Client Secret", separated by a slash. What you need, right now, is just the first code!

To access the "Access Token" of the application, you need to click on "Details", at the end of the line corresponding to your application. The page that will be shown contains the code for the " Access Token " of that application, the application to which that token is linked and whether the "Access Token" is active or not.

Important! Each created application has its own "Client ID" and an "Access Token" associated with it. In addition, the PIER {Labs} API has different Access Tokens for Sandbox and Production environment (the application generated in this tutorial works only as Sandbox, for example). That is, in case of any error in the application, the first step to be tested is whether both codes are actually correct and correspond to the scope of the environment in which you are developing.

 

Step 3 - Testing the PIER API {Labs} in Sandbox

One of the differentials of PIER {Labs} is that the API is publicly available on the site, with all its documentation. That is, it is not necessary to be a registered user to know the full potential. To access this information, a testing environment called "API Browser is available" for interaction with the PIER {Labs} API. In it, it is possible, besides knowing the documentation of the API, that a developer with a registered application can test all the calls of the methods available in the API, but with a generic database (the so-called Sandbox environment). Another great differential is the fact that the API is exactly the same for Sandbox and Production! This allows the developer to thoroughly test your application before making it available in the Production environment. Note that the Production Access Token will not work in the "Browser API"! To access this functionality, simply navigate the menu in the upper bar of the site, go to "Tools" and then go to "API Browser".

The"API Browser" can be accessed through the following link (it should appear a page with the available versions of the API, simply clicking the desired one) http://pierlabs.io/api-portal/swagger.
After choosing the version, a screen will be displayed containing all the resources, or services, available in the API, grouped by topic of interest.

Each service has a brief description of its functionality, structure, parameters, and a list of response messages to help with development. At the end of each, note that there is a "Try it out!"Button. As long as you have a "Client ID" and an "Access Point" inserted at the top of the page, you can test each of the features by clicking this button..

After that, some information will appear just below the screen. The first one is the complete "cURL" efetuada pelo API Browser. Note que aparece o endpoint de Sandbox dentro da chamada.

Because the PIER {Labs} API is RESTful-based, to exchange messages between the application and the Conductor server, you must use the following HTTP methods:GET, POST e PUT. Whenever you need to retrieve information, the GETmethod will be used; create an object, thePOST methor will be chosen; and an entry,,the PUT method will be used. In addition, all message exchanges occur through JSONobjects.

A little further down, we have the service response, if any, in addition to the response code, indicating whether the call occurred successfully (response code 200, by default) or otherwise the problem code.

Now it's time to start your own applications!

English