How to Access API Documentation

Introduction

Reportana’s API documentation serves as a guide for integrating other applications with our platform. It provides detailed information such as endpoint descriptions, request and response formats, authentication requirements, and available parameters. This information helps developers understand how to use our API effectively and securely.

Important: We emphasize that using the API documentation is recommended exclusively for developers or for those who have the assistance of a developer.

How it works

How to access documentation through our website

1. Visit our website at: https://reportana.dev/en

2. Our API documentation will open in a new tab, containing all the information needed.

How to access the documentation through the platform

1. In your Reportana account, navigate to Settings in the side menu → API Keys. Or access: Settings — API Keys.

2.In this section, you can generate API keys for your account. API keys are used to authenticate and authorize access to the Reportana API. They ensure that only authorized users and applications can interact with our API.

3. To create new API keys, click on + CREATE ➞ give a name to the desired integration ➞ click on CREATE again. This way, the keys will be generated automatically.

4. In the same tab, you will also have access to the API documentation. Just click on Documentation to access.