Skip to main content

Getting Started

Welcome to the Getting Started section of the documentation! Here you'll find the necessary guidance to start using our API and integrate our solutions into your system with ease.

Our API is designed to be intuitive and efficient, allowing you to connect your systems to Sopague payment and conciliation features quickly.

Step 1: Choose the desired functionality​

Sopague offers a range of functionalities to meet different needs. Before you begin, choose the API that best fits your use case:

Each API has specific documentation, which you can access in the sidebar menu.

Step 2: Perform authentication​

To access the web conciliation platform, visit https://ib.sopague.com.br/.

To consume any of our functionalities via API, follow the steps below:

  • Obtain the userName and password by providing the necessary data to our team (CNPJ, company name, technical contact, and server IP).
  • Log in with POST /api/auth/token, sending userName and password.
  • Receive the authentication token in the accessToken field.
  • Include the token in the Authorization header to use other endpoints.
  • Renew the token before it expires.

For more details, see the Authentication section.

Step 3: Start using​

Now that you've chosen the API and configured your authentication, it's time to integrate the functionalities into your system:

  1. Check the available endpoints in the specific documentation for the chosen API.
  2. Perform test calls using tools like Postman or cURL.
  3. Integrate the endpoints into your system, following the practical examples and best practices indicated.

That's it! With these steps, you can now start using the Sopague APIs and take advantage of all the benefits of our solutions.

If you need help, our team is available. Explore the documentation for more information and happy integrating!