Como criar uma chave de API

Last updated: September 23, 2026

Visão geral

As chaves de API permitem que sistemas externos se integrem com o L2L para fins específicos (por exemplo, abrir despachos, submeter dados reais de produção). Como as chaves de API concedem acesso programático aos dados do seu site, a sua criação está limitada a utilizadores autorizados e deve ser cuidadosamente definida e controlada.

Pré-requisitos e preparação

  • Permissões necessárias: Administrador ou um utilizador com a designação Gestor de API .

  • Dependência: Tem de confirmar o seu nível de permissões antes de prosseguir — verifique Menu de configuração > Definições de segurança do administrador para ver quais os utilizadores marcados como Administrador ou Gestor de API (definido como True). Se não tiver este acesso, contacte um dos utilizadores que o tenha.

  • Nota: O Suporte L2L não pode criar nem conceder chaves de API aos clientes. Por motivos de segurança, as chaves de API têm de ser criadas por utilizadores autorizados no seu próprio site, com as permissões de Administrador necessárias.

mceclip0.png

Configuração passo a passo

  1. Determinar a finalidade da chave de API: Decida para que será utilizada a chave (por exemplo, abrir despachos, submeter dados reais de produção).

  2. Criar uma conta de utilizador dedicada: Como prática recomendada, crie uma nova conta de utilizador com um nome de utilizador exclusivo para o caso de utilização — por exemplo, Dispatch_API ou Production_API.

  3. Atribuir o estado de Administrador: Dê ao novo utilizador um nome de utilizador e uma palavra-passe exclusivos e marque esse utilizador como Administrador.

  4. Gerar a chave: Clique no botão Gerar nova chave de API para criar automaticamente a chave de API.

  5. Definir atributos:

    • Atribuir um proprietário: Designe uma pessoa responsável por saber para que é utilizada a chave, em caso de problemas ou alterações na integração.

    • Restringir endpoints: Opcionalmente, designe endpoints de API específicos para utilização pela chave, limitando o seu âmbito (por exemplo, restringindo-a apenas a Produção ou Peças sobresselentes, em vez de todas as APIs).

  6. Guardar e finalizar: Confirme que a chave foi gerada e devidamente limitada.

Práticas recomendadas:

  • uma chave de API exclusiva por combinação de servidor + aplicação

  • Inclua "API" no nome de utilizador para facilitar a pesquisa