API Reference

Postman Integration

Lerian’s Postman collections are a quick way to get hands-on with our APIs. You can test requests, receive real responses, and explore how the APIs fit together. Whether you’re building or debugging, they help you move faster and more confidently.

You’ll find a Postman collection in the postman folder of every Lerian repository—ready to use as soon as you clone the project.

📘

Note

Refer to Postman’s documentation to learn more about importing collections.


Importing the Postman Collection

To import the Postman collection, follow these steps:

  1. Open Postman.
  2. Click "Import" in the top-left corner.
  3. In the Import modal, select the "File" tab.
  4. Click "Choose Files", then navigate to the postman folder inside the repository you cloned from GitHub.
  5. Postman will process the file and add the collection to "Collections" in your workspace.
  6. Open the collection and verify that all API requests and folders are correctly imported.

Tokens and Authentication

If you are using Midaz or Midaz Console in the Community model, you do not need to authenticate or access tokens — you're good to go.

For the Enterprise model, you can enable authentication and token management using the Access Manager plugin.

👍

Tip

Access Manager is available as a part of the Enterprise model. If you'd like to learn more or evaluate it for your use case, get in touch with our team.