Conectar a ShippingEasy: verificar suas credenciais de API

Copie sua API Key e seu API Secret da mesma página API Credentials da ShippingEasy, cole no Integration e execute o teste assinado: esta conexão só verifica credenciais.

O conector da ShippingEasy verifica suas credenciais de API da ShippingEasy no Integration. Você preenche uma API Key e um API Secret; cada solicitação é assinada com o secret usando HMAC-SHA256, e o secret em si nunca é enviado em texto puro. Esta conexão serve só para verificação de credenciais: com a Customer API da ShippingEasy ela não oferece comparação de tarifas, compra de etiquetas nem consulta de rastreio por número de rastreio.

Pré-requisitos#

• Uma conta da ShippingEasy, com acesso a Settings → API Credentials.
• Tenha prontos sua API Key e seu API Secret: os dois estão na mesma página, Settings → API Credentials (app.shippingeasy.com/settings/api_credentials).
• Saiba para que serve esta conexão antes de começar: ela só verifica credenciais. Não adiciona ao Integration comparação de tarifas, compra de etiquetas nem consulta de rastreio.

Obter credenciais#

1. Entre na ShippingEasy e vá para Settings → API Credentials (app.shippingeasy.com/settings/api_credentials).
2. Nessa página, copie a API Key. É a chave de API pública desta conta.
3. Na mesma página, copie o API Secret. É o segredo de API privado: cada solicitação é assinada com ele usando HMAC-SHA256, e o secret em si nunca é enviado em texto puro.
4. Guarde a Key e o Secret juntos como um par retirado daquela única página, e guarde o Secret em local seguro.

Preencher no Integration#

1. Abra Integration → Marketplace → ShippingEasy → Nova conexão.
2. API Key (api_key), obrigatório: cole a API Key de ShippingEasy → Settings → API Credentials. Preencha a Key só no campo Key: não a troque com o Secret.
3. API Secret (api_secret), obrigatório: cole o API Secret da mesma página Settings → API Credentials. É criptografado em repouso e nunca exibido; o Integration o usa para assinar cada solicitação com HMAC-SHA256, e o Secret em si não é enviado em texto puro.

Testar a conexão#

Clique em Testar a conexão. O teste assina uma solicitação somente leitura com seu API Secret e lista pedidos com GET https://app.shippingeasy.com/api/orders?per_page=1: só 1 pedido como sonda. Se passar, as credenciais assinadas funcionam e conseguem listar pedidos. Não prova mais nada: não verifica tarifas, não compra etiqueta nem busca rastreio, porque esta conexão não oferece esses recursos.

Mapping / escolher modelo#

Nesta conexão não há mapping nem modelo para escolher. Ela não traz pedidos para outro sistema nem mapeia serviços de envio: com a Customer API da ShippingEasy, a comparação de tarifas, a compra de etiquetas e a consulta de rastreio por número de rastreio não são suportadas por esta conexão, então não há nada para mapear para elas. Se precisar de tarifas ou etiquetas, faça esse trabalho na própria ShippingEasy.

Ativar#

Após ativar, a conexão é salva como verificada e fica pronta para verificações de credenciais. Nada mais começa a funcionar por ela: comparação de tarifas, compra de etiquetas e consulta de rastreio não fazem parte desta conexão, então continue fazendo isso na própria ShippingEasy. Se você substituir a API Key ou o API Secret na ShippingEasy, atualize os dois valores aqui e teste novamente.

Perguntas frequentes#

O teste falha com 401

A API Key ou o API Secret está incorreto, ou os dois foram trocados, então a assinatura HMAC-SHA256 não confere e a ShippingEasy rejeita a sonda assinada.

Volte a ShippingEasy → Settings → API Credentials (app.shippingeasy.com/settings/api_credentials), copie a API Key no campo API Key e o API Secret no campo API Secret exatamente como exibidos naquela mesma página, e teste novamente.

O teste diz que faltam credenciais

Um ou os dois campos estão vazios. O teste não consegue assinar uma solicitação sem a API Key e o API Secret ao mesmo tempo, então para antes de executar a sonda.

Preencha os dois campos a partir da mesma página Settings → API Credentials, salve e teste novamente. Preencher só um dos dois não basta.

O teste passa, mas não consigo comparar tarifas, comprar uma etiqueta nem consultar o rastreio

Esse é o escopo desta conexão, não uma falha: ela só verifica credenciais. Um teste aprovado só prova que as credenciais assinadas conseguem listar pedidos: a Customer API da ShippingEasy não dá a esta conexão um endpoint de tarifas, um endpoint de compra de etiquetas nem um endpoint de rastreio por número.

Use esta conexão só para verificações de credenciais, e continue fazendo tarifas, etiquetas e o restante do trabalho de envios na própria ShippingEasy. Não espere que um teste aprovado ative esses recursos no Integration.