O Token da API de Integração (API Key) é utilizado para permitir a comunicação entre a plataforma MaisEntregas e sistemas externos, como e-commerces, ERPs e outras plataformas integradas.

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

Entendendo os tipos de Token

• Token do Administrador (ADM): Possui acesso total ao sistema. Deve ser usado quando a integração precisa gerenciar a operação logística de forma ampla, como listar corridas de toda a plataforma usando filtros avançados, cadastrar novos clientes via sistema ou gerar pedidos em nome de múltiplos clientes diferentes.  

• Token do Cliente Solicitante: Possui acesso restrito apenas à conta do próprio usuário (identificado na API como "cliente"). Deve ser usado quando o sistema integrado (como a loja virtual do cliente) precisa exclusivamente consultar, cancelar ou gerar as suas próprias corridas de entrega. 

⚙️ Administrador (ADM)

🔑 Como acessar a API Key pelo ADM

Após realizar o login na plataforma 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 apresentado nesse campo.
5. Envie a API Key para a equipe responsável pelo sistema que será integrado à MaisEntregas.

O caminho é:

⚙️ Engrenagem → Alterar dados de usuário → API Key

👤 Cliente Solicitante

🔑 Como acessar a API Key

Após realizar o login no ambiente do Cliente Solicitante:

1. Acesse o Menu da plataforma.
2. Localize e clique na opção Integração via API.
3. Na tela de integração, será exibida a sua API Key.
4. Copie o código apresentado.

Importante: a API Key é o Token de autenticação da integração. Ela será utilizada pelo sistema integrado para se comunicar com a plataforma MaisEntregas.

🖥️ Onde encontrar o Token

Acesse:

Menu → Integração via API → API Key

✅ Pronto!

O código exibido no campo API Key é o seu Token da API de Integração.

Esse Token deverá ser utilizado pela equipe responsável pela integração para permitir a comunicação entre o sistema externo e a plataforma MaisEntregas.

🔒 Atenção à segurança

A API Key é uma credencial de acesso. Compartilhe-a somente com a equipe ou empresa responsável pela integração e evite divulgá-la publicamente.

Em caso de dúvidas durante a configuração, entre em contato com o Suporte MaisEntregas.