8.5. Agentes
Autenticação
Para realizar requisições aos nossos endpoints, é necessário utilizar uma API Key válida. Esta chave é o identificador que garante a segurança e o controle de acesso às operações da plataforma.
| Key | Value |
|---|---|
| apikey | {{apikey}} |
aviso
Importante: Mantenha sua API Key em segurança. Ela é pessoal, intransferível e dá acesso direto às operações de crédito e dados de clientes da sua conta.
GET Consultar Agentes
/v3/brokers
Retorna a lista de agentes cadastrados, com suporte a busca por texto.
Parâmetros de Query
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
searchText | string | Não | Texto para busca por nome, documento ou apelido |
Exemplo de Requisição e Resposta
- cURL
- 200 - Sucesso
- 400 - Erro
Visualizar cURL
curl --location --request GET 'https://integration.ajin.io/v3/brokers?searchText=' \
--header 'apikey: {{apikey}}'
Visualizar Response
{
"total": 1,
"data": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"nickname": "string",
"identity": "00.000.000/0001-00",
"status": 1,
"createdAt": "2024-01-15T10:00:00Z"
}
]
}
Visualizar Response
{
"messages": [
{
"code": "9001002",
"text": "Parâmetros inválidos"
}
]
}