API da Machine

O que é API?

API (Interface de Programação de Aplicações) é um conjunto de normas e protocolos que permite que diferentes softwares se comuniquem e troquem dados de forma estruturada.

Na prática, ela atua como um intermediário, garantindo que um sistema consiga solicitar informações de outro e receba uma resposta compreensível.

Exemplo do Restaurante: Para entender melhor, imagine que você está em um restaurante:

Você (O Cliente): É o aplicativo que precisa de uma informação ou serviço.

A Cozinha (O Sistema): É onde os dados e processos estão guardados.

O Garçom (A API): É quem leva o seu pedido até a cozinha e traz o prato pronto de volta para você.

Sem o garçom (a API), você teria que entrar na cozinha e entender como ela funciona para conseguir o que quer. A API simplifica esse processo, oferecendo apenas o que você precisa.

Sobre a API da Machine

A API (Interface de Programação de Aplicações) da Machine foi desenvolvida para permitir a integração do nosso sistema com outras plataformas e ferramentas, proporcionando mais flexibilidade e automação para a sua central.

Com a API da Machine, é possível:

Abrir corridas ou entregas
Consultar dados de condutores e clientes
Atualizar informações da carteira de crédito
Verificar o status de ordens de serviço (OS)
E muito mais

Requisitos para utilização

Para realizar a integração corretamente, é fundamental que a central conte com o suporte de um desenvolvedor. Esse profissional deve ter um login na plataforma com perfil Gestor. Caso precise de ajuda para criar esse usuário, Neste artigo te orientamos melhor.

Não compartilhe dados como chaves API ou senhas de acesso: Estes dados são de uso pessoal e intransferível do administrador do sistema. O compartilhamento dessas informações em canais de comunicação abertos cria vulnerabilidades que podem ser exploradas por terceiros mal-intencionados.

Como obter a chave de API

A chave de API é gerada automaticamente para todas as centrais, sem necessidade de contato com o suporte da Machine.

Para acessar, basta entrar em Configuração > Integrações > Machine API.

Com essa chave, é possível acessar os ambientes de teste e produção da plataforma, permitindo que o desenvolvedor valide a integração antes de colocá-la em funcionamento.

Documentação da API

Abaixo estão os links com a documentação detalhada da API, contendo todos os endpoints disponíveis atualmente:

Como cancelar a integração

Se a central decidir desativar a integração com a API, basta solicitar a remoção da chave ao nosso time de suporte, via e-mail ou chat.

Em caso de dúvidas, nossa equipe está à disposição para ajudar.

Pesquisa

Bem-vindo!