0.2. Sobre
GET Sobre
https://integration.ajin.io/v3/about
Este endpoint fornece informações gerais sobre a API e serve para verificar se o serviço está operando corretamente.
Exemplo de Requisição e Resposta
- Example Request
- Example Response
curl --location https://integration.ajin.io/v3/about
{
"name": "JoinBank API",
"version": "3.0.0",
"description": "API de Simulação e Cadastro de Empréstimos",
"status": "online"
}
Padrões
Nesta seção, descrevemos os padrões tecnológicos e de comunicação utilizados em toda a infraestrutura da API JoinBank.
Ambientes e URLs Base
As rotas nesta documentação são relativas. A URL base é gerenciada pela variável de coleção {{baseUrl}}.
| Variável | Serviço | Ambiente | Valor |
|---|---|---|---|
| baseUrl | API Principal | Produção | https://integration.ajin.io |
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}} |
Formatos de Dados
- Tipo de API: RESTful
- Autenticação: API KEY
- Protocolo: HTTPS
- Requests e Responses: JSON (
application/json) - Identificadores: UUID v4 (ex:
b3b0e362-8aa2-4b3c-b8cd-8a9142eafe64) - Datas: Formato ISO 8601 (ex:
2025-11-13T14:44:00Z)
Consultas e Filtros
O tipo de chamada padrão para consultas é POST, com os filtros sendo passados via BODY no formato JSON.
{
"code": {
"eq": 73
}
}