Skip to content

Autenticação ​

Como obter e usar a credencial de uma integração do iPaaS.


Cada integração do iPaaS tem uma credencial exclusiva, formada por uma Chave (clientId) e uma Secret (clientSecret). Ela é criada junto com a integração e só autoriza a execução daquela integração. Com essa credencial você gera um token de acesso e envia o token em todas as chamadas de execução.

Obtendo a credencial ​

A credencial é gerada automaticamente quando a integração é criada. No Partner's Portal, a Secret completa só fica disponível enquanto o assistente de criação está aberto, na mesma aba do navegador: na etapa Parâmetros (pelo ícone de olho e pelo botão de copiar) e, ao final da publicação, na tela Integração ativada com sucesso.

CampoDescrição
Chave (clientId)Identificador da credencial, no formato integrationhub-{flowId}, em que {flowId} é o ID da integração (o mesmo que aparece na Endpoint URL).
Secret (clientSecret)Segredo da credencial. Na tela Integração ativada com sucesso, ele aparece visível, com o botão de copiar. Fora do assistente de criação, o portal mostra só o início e o fim.

❗️ Atenção

Copie e guarde a Secret em um local seguro antes de sair do assistente de criação. Se você sair do assistente ou fechar a aba antes de copiá-la, ela não pode ser recuperada, e será preciso criar uma nova integração.

Editar e publicar novamente uma integração mantém a mesma Chave e Secret: o seu sistema não precisa trocar a credencial.

📘 Nota

A credencial da integração também aparece na tela API Keys, com a Chave integrationhub-{flowId}, mas não pode ser excluída ali: ela é removida junto com a integração. Ela é diferente de uma API Key comum, porque só executa esta integração.

📘 Nota

Na Busca de Produtos não há credencial a copiar: quem chama a integração é o próprio ME. Ao publicar, o portal mostra uma confirmação e volta para Minhas Integrações.

Gerando o token de acesso ​

Troque a Chave e a Secret por um token de acesso usando o endpoint POST Generate Token, da API de autenticação do ME.

http
POST https://api.mercadoe.com/v1/auth/tokens
Content-Type: application/json
json
{
  "clientId": "integrationhub-{flowId}",
  "clientSecret": "{secret}"
}

Resposta:

CampoDescrição
accessTokenToken a ser enviado no header Authorization das chamadas de execução.
expiresInValidade do token. Quando o token expirar, gere um novo com a mesma Chave e Secret.

Veja o formato completo da resposta em Generate Token.

Usando o token ​

Envie o token no header Authorization com o prefixo Bearer:

http
POST https://api.mercadoe.com/integration-hub-api/v1/flows/{flowId}/execute
Authorization: Bearer {accessToken}
Content-Type: application/json

📘 Nota

O token gerado com a credencial de uma integração só executa essa integração. Uma chamada para a Endpoint URL de outra integração é recusada com 403 Forbidden.

Boas práticas ​

  • Guarde a Secret em um cofre de segredos. Nunca a coloque em código-fonte, logs ou URLs.
  • Reaproveite o token enquanto ele for válido, em vez de gerar um novo a cada chamada.
  • Use uma integração, e portanto uma credencial, para cada finalidade. Assim você revoga ou suspende uma sem afetar as outras.