API Reference
A API Reference é uma documentação interativa disponível diretamente no ContractFlow. Ela permite visualizar, explorar e testar todos os endpoints de integração de forma prática.
URL da API Reference
https://api-{base-url}/contractflow/docs/integration
Recursos da API Reference
-
Visualização interativa - Navegue por todos os endpoints organizados por recurso
-
Teste direto - Execute requisições diretamente pelo navegador
-
Exemplos prontos - Veja exemplos de request/response para cada endpoint
-
Documentação Swagger - Baseada na especificação OpenAPI/Swagger
Como Usar
1. Acesse a URL
Abra a URL da API Reference do seu ambiente no navegador.
2. Autentique-se
-
Clique no botão Authorize (ou similar, depende da interface)
-
Informe sua
x-api-key -
Informe sua
x-api-secret -
Confirme a autenticação
3. Explore os Endpoints
Após autenticar, você pode:
-
Navegar pelos diferentes recursos no menu lateral
-
Clicar em um endpoint para ver detalhes
-
Ver os parâmetros esperados (path, query, body)
-
Visualizar os modelos de resposta
4. Teste uma Requisição
-
Selecione o endpoint desejado
-
Preencha os parâmetros necessários
-
Clique em Execute ou Try it out
-
Visualize a resposta
Recursos Disponíveis (Glossário)
| Recurso | Descrição |
|---|---|
| Health Check | Verificar status da API |
| Document | Gestão de documentos |
| Supplier | Gestão de empresas fornecedoras |
| Contract Type | Gestão de categorização de contrato |
| Contract | Gestão de contratos |
| Member | Gestão de membros da organização |
| Person | Gestão da identidade de pessoas |
| Position | Gestão de funções de membros |
| Position Description | Gestão da definição da posição de membros |
| Allocation Type | Gestão de categorização de alocação |
| Allocation | Gestão de alocações/vínculos de prestadores de serviço |
| Outsourced Employee | Gestão de prestadores de serviço |
Códigos de Status
| Código | Descrição |
|---|---|
| 200 | Requisição bem-sucedida |
| 201 | Recurso criado com sucesso |
| 400 | Bad Request - Parâmetros inválidos |
| 401 | Unauthorized - Credenciais inválidas ou não fornecidas |
| 403 | Forbidden - Permissão negada |
| 404 | Not Found - Recurso não encontrado |
| 500 | Internal Server Error - Erro no servidor |
Erros mais comuns
401 - Unauthorized
Causa: Credenciais não fornecidas ou inválidas.
{
"message": "Unauthorized"
}
Solução: Verifique se os headers x-api-key e x-api-secret estão corretos.
403 - Forbidden
Causa: Permissão negada para acessar o recurso.
{
"message": "Permission denied."
}
Solução: Entre em contato com o administrador do sistema para obter as permissões necessárias.
