O Token da API de Integração (API Key) permite que sistemas externos, como e-commerces, ERPs e outras plataformas, se comuniquem com a MaisEntregas.

A API Key pode ser localizada pelo ambiente do Cliente Solicitante ou pelo ambiente Administrador (ADM).

Tipos de Token

  • Token do Administrador (ADM): tem acesso total ao sistema. Use quando a integração precisa gerenciar a operação de forma ampla, como listar corridas de toda a plataforma com filtros avançados, cadastrar novos clientes ou gerar pedidos em nome de vários clientes diferentes.
  • Token do Cliente Solicitante: tem acesso restrito à conta do próprio usuário (identificado na API como "cliente"). Use quando o sistema integrado, como a loja virtual do cliente, precisa apenas consultar, cancelar ou gerar as próprias corridas de entrega.

Como acessar a API Key pelo ambiente Administrador (ADM)

Depois de fazer login como Administrador (ADM):

  1. No canto superior direito da plataforma, clique no ícone de engrenagem.
  2. Selecione a opção "Alterar dados de usuário".
  3. Localize o campo API Key.
  4. Copie o código exibido nesse campo.
  5. Envie a API Key para a equipe responsável pelo sistema que será integrado à MaisEntregas.

Caminho: Engrenagem > Alterar dados de usuário > API Key.

Tela de Alterar dados de usuário no ambiente administrativo, com o campo API Key a ser copiado.

Como acessar a API Key pelo ambiente do Cliente Solicitante

Depois de fazer login no ambiente do Cliente Solicitante:

  1. Acesse o Menu da plataforma.
  2. Clique em "Integração via API".
  3. Na tela de integração, será exibida a sua API Key.
  4. Copie o código apresentado.

Caminho: Menu > Integração via API > API Key.

Tela do ambiente do Cliente Solicitante com o menu Integração via API, onde aparece o campo API Key.

Importante: a API Key é o Token de autenticação da integração. O sistema integrado a utiliza para se comunicar com a MaisEntregas.

Segurança

A API Key é uma credencial de acesso. Compartilhe-a somente com a equipe ou empresa responsável pela integração e não a divulgue publicamente. Em caso de dúvidas na configuração, entre em contato com o Suporte MaisEntregas.