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

1. Clique no botão Authorize (ou similar, depende da interface)

2. Informe sua x-api-key

3. Informe sua x-api-secret

4. 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

1. Selecione o endpoint desejado

2. Preencha os parâmetros necessários

3. Clique em Execute ou Try it out

4. Visualize a resposta

Recursos Disponíveis (Glossário)

Códigos de Status

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.