canonical: https://jentic.com/apis/swaggerhub.gmf-tech/api-customer

# Gmf Tech API Customer

Swagger da API responsável pela configuração de clientes. The API exposes 27 endpoints secured with oauth2 authentication.

## For AI agents

Programmatically retornar as configurações completas do cliente | scope-> configuration:read
, cria um novo cliente, vinculado à um usuário do sistema. | scope-> configuration. Covers 27 operations with oauth2 authentication.

## Scope

Does not handle payments, communications, or crm - use for developer tools only.

## Capabilities

- Retornar as configurações completas do cliente | scope-> configuration:read
- Cria um novo cliente, vinculado à um usuário do sistema. | scope-> configuration
- Atualiza dados do cliente. | scope-> configuration:write
- Faz o upload da imagem do cliente (empresa). | scope-> configuration:write
- Inclui um novo endereço para o cliente/empresa. | scope-> configuration:write

## Use cases

### Developer Tools Operations

Use the API Customer to perform developer tools operations programmatically. The API provides 27 endpoints covering core functionality including retornar as configurações completas do cliente | scope-> configuration:read
, cria um novo cliente, vinculado à um usuário do sistema. | scope-> configuration, retornar as configurações básicas do cliente | scope-> configuration:read
.

Example prompt: Call GET /customer/complete to retornar as configurações completas do cliente | scope-> configuration:read

### Automated General settings Management

Automate general settings operations by combining multiple API Customer endpoints. Agents can cria um novo cliente, vinculado à um usuário do sistema. | scope-> configuration and then retornar as configurações básicas do cliente | scope-> configuration:read
 in a single workflow.

Example prompt: Call POST /customer to cria um novo cliente, vinculado à um usuário do sistema. | scope-> configuration, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call API Customer endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle oauth2 tokens manually.

Example prompt: Search Jentic for 'retornar as configurações completas do cliente | scope-> configuration:read
', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | /customer/complete | Retornar as configurações completas do cliente \| scope-> configuration:read |
| POST | /customer | Cria um novo cliente, vinculado à um usuário do sistema. \| scope-> configuration |
| GET | /customer | Retornar as configurações básicas do cliente \| scope-> configuration:read |
| PUT | /customer | Atualiza dados do cliente. \| scope-> configuration:write |
| PUT | /customer/logo | Faz o upload da imagem do cliente (empresa). \| scope-> configuration:write |
| PUT | /customer/statements | Atualiza as declarações do cliente. \| scope-> configuration:write |
| POST | /customer/address | Inclui um novo endereço para o cliente/empresa. \| scope-> configuration:write |
| GET | /customer/address | Retornar os endereços do cliente/empresa \| scope-> configuration:read |

## Key resources

- **General settings** — Configuração do cliente (empresa)
- **Addresses** — Endereços vinculados ao cliente (empresa)
- **Responsible contacts** — Configuração dos responsáveis (contatos) pelo cliente (empresa)
- **Bank information** — Informações bancárias utilizadas pelo cliente (empresa)
- **Document files** — Arquivos de documentos do cliente (empresa)

## Why Jentic

- **Setup:** Wiring the Bidbr API Customer service by hand means running its OAuth2 password flow against api-login.bidbr.com.br, mapping the right ACL scopes, and handling token refresh and retries yourself. Through Jentic you install once, import API Customer from the API Directory, store the credentials once, and your agent calls it.
- **Permission scoping:** The customer operations act on the authenticated account and carry their target in the request body, so scoping is operations-only: you limit the agent to the operations it needs, such as reading customer details or addresses, and leave out writes like creating a customer or updating the logo unless you add them.
- **Credential handling:** Your API Customer OAuth2 credentials are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'read complete customer configuration' or 'add a customer address', and Jentic returns the matching API Customer operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Github** — Alternative developer tools API
- **Gitlab** — Alternative developer tools API

## FAQ

### What authentication does the API Customer use?

The API Customer uses OAuth 2.0 for authorization. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I retornar as configurações completas do cliente | scope-> configuration:read
 with the API Customer?

Yes. Use the GET /customer/complete endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the API Customer?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I retornar as configurações completas do cliente | scope-> configuration:read
 through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'retornar as configurações completas do cliente | scope-> configuration:read
'. Jentic returns the matching API Customer operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the API Customer have?

The API Customer exposes 27 endpoints covering general settings, addresses, responsible contacts operations.

### Can I limit what my agent is allowed to do with the API Customer?

Yes. Because you run Jentic One yourself, your own rules decide which API Customer operations and credentials the agent can use. Since every call acts on the authenticated account and carries its target in the request body, scoping is operations-only: you can allow read operations such as GET /customer/complete or GET /customer/address while leaving out writes like POST /customer or PUT /customer/logo. The agent can only call the operations you have granted, and its OAuth2 credentials are injected at execution time rather than exposed in the prompt.