A API REST do Mycroft permite integrar analise de credito de borderos CNAB 400 diretamente no seu sistema, com transparencia total sobre cada regra aplicada.
Base URL
https://api-mycroft.sherlocker.com.br/api/v1
/v1/.
Autenticacao
Todas as rotas exigem um Bearer token no header Authorization:
Authorization: Bearer myc_xxxxxxxxxxxxx
Content types
Requests:
| Tipo | Uso |
|---|
application/json | Maioria dos endpoints (criacao e atualizacao de recursos) |
multipart/form-data | Upload de arquivo (POST /v1/operations) |
| Tipo | Uso |
|---|
application/json | Respostas de sucesso |
application/problem+json | Respostas de erro (RFC 7807) |
Upload de XMLs NFe
O endpoint POST /v1/operations aceita um parametro opcional xmls com um arquivo ZIP contendo XMLs de NFe. Quando fornecido, as regras de NFe utilizam os dados do XML ao inves de consultar a API Sherlocker NFe.
Versionamento
A versao da API e definida no prefixo da URL (/v1/). Versao atual: v1.
Mudancas retrocompativeis (novos campos, novos endpoints) nao incrementam a versao. Mudancas incompativeis resultarao em uma nova versao (/v2/).
Endpoints
| Metodo | Path | Descricao |
|---|
| POST | /v1/operations | Criar nova operacao de analise |
| GET | /v1/operations/ | Consultar status de uma operacao |
| GET | /v1/operations//result | Obter resultado da analise |
| GET | /v1/engines | Listar motores de regras |
| POST | /v1/engines | Criar novo motor de regras |
| GET | /v1/engines/ | Consultar motor especifico |
| PUT | /v1/engines/ | Atualizar motor de regras |
| DELETE | /v1/engines/ | Remover motor de regras |
| GET | /v1/openapi.json | Especificacao OpenAPI (sem autenticacao) |
Navegue pelas secoes Operacoes e Motores de Regras na barra lateral para ver a documentacao completa de cada endpoint com playground interativo.
