API de Integração v2
Integre seu sistema com a plataforma Machine de maneira simples, segura e eficaz. Este guia contém tudo o que você precisa para começar sua jornada conosco.
Quem Somos
Evolução Constante
HATEOAS na v2
HATEOAS é um padrão em que o próprio retorno da API guia você pelos endpoints relacionados ao recurso consultado.
Com esses links, seu sistema consegue identificar quais próximas ações estão disponíveis sem consultar a documentação
a cada etapa do fluxo. Na v2, esses links ficam no objeto __links.
Estrutura do objeto __links
__links representa uma ação disponível.
O valor da chave informa o endpoint e o método HTTP que devem ser usados para executar essa ação.__links: objeto que agrupa os links HATEOAS retornados pela API.self: link para consultar o próprio recurso retornado na resposta.href: caminho do endpoint que deve ser chamado.metodo: método HTTP aceito pelo endpoint, comoget,postoupatch.- Demais chaves, como
atualizar-dinamica-area: ações relacionadas ao recurso atual.
Como usar
Primeiro chame um endpoint que retorna HATEOAS. Depois escolha uma ação em __links e faça a próxima
requisição usando o href e o metodo da resposta.
Endpoints com HATEOAS
| Recurso | Endpoints |
|---|---|
| Corridas | POST /api/v2/integracao/corridas/consultarPOST /api/v2/integracao/corridas/ |
| Corridas programadas | GET /api/v2/integracao/corridas/programadasPOST /api/v2/integracao/corridas/programadas |
| Entregas | POST /api/v2/integracao/entregas/consultarPOST /api/v2/integracao/entregas |
| Entregas programadas | GET /api/v2/integracao/entregas/programadasPOST /api/v2/integracao/entregas/programadas |
| Créditos da empresa em entregas | GET /api/v2/integracao/entregas/empresas/creditos/saldoPOST /api/v2/integracao/entregas/empresas/creditos/recargasPOST /api/v2/integracao/entregas/empresas/creditos/saques |
| Clientes | GET /api/v2/integracao/clientes |
| Condutores | GET /api/v2/integracao/condutores |
| Créditos de condutores | POST /api/v2/integracao/condutores/creditos/saldo/consultarPOST /api/v2/integracao/condutores/creditos/recargasPOST /api/v2/integracao/condutores/creditos/saques |
| Empresas | GET /api/v2/integracao/empresasPOST /api/v2/integracao/empresas |
| Dinâmicas | GET /api/v2/integracao/dinamicas/areaGET /api/v2/integracao/dinamicas/sem-area |
| Mensagens | POST /api/v2/integracao/mensagens/condutor/broadcastPOST /api/v2/integracao/mensagens/condutor/{id}POST /api/v2/integracao/mensagens/empresa/broadcastPOST /api/v2/integracao/mensagens/empresa/{id} |
Primeiros passos
Explore a tab “Referência” para obter mais informações sobre como se conectar à API e testar os endpoints.
