API Requirements for Use in Controlled Flow

📄Model Document for Usage: API Specification Document

What API information do we need to receive?

To configure Controlled Flow with any API, the documentation must provide the following data.

1.1 API Endpoint:

Main Base URL.
Specific endpoint that will be used by Controlled Flow.

2. Where to get or generate the API access key?

2.1 API Key:

Information on where to generate or access the API key.
If you already have the key, just send it.

2.2 Does the API use a generated token?

If the API requires a token generated via another endpoint, we need:
Endpoint responsible for generating the token.
Necessary credentials.
Expected response format.

3. API Documentation

The documentation should be up-to-date and include:
Description of the endpoints.
Supported methods.
Recent payload example.
Structure of fields that Controlled Flow will need to extract.

4. What parameters do we need to test the API?

Test parameter examples:
Email
CPF
Order number
Other identifiers used by the API.

5. Examples of Ideal Documentation

An ideal documentation should contain:
Base URL + detailed endpoints.
Method (GET, POST, PUT, DELETE).
Necessary headers.
Request example (JSON).
Response example (JSON).
Explanation of each field.
Authentication flow (if any).

6. Common errors and how to handle them.

The documentation should list the main errors returned by the API, with clear explanations so we can identify, interpret, and correct them properly in case of failures. It's important to include: