Autenticação e formato dos dados

Neste tópico iremos abordar quais são os headers e o formato necessários para integrar com a API da Americanas. Importante seguir todas as instruções para que a requisição ocorra com sucesso

Autenticação

Todas as chamadas aos serviços disponíveis na API SkyHub devem ser autenticadas a partir do e-mail do usuário, token de acesso e account manager key. Essas informações devem ser enviadas no cabeçalho (header) de cada requisição conforme descrito abaixo:

# Headers de autenticação
X-User-Email: email_de_usuario 
X-Api-Key: token_de_integracao de sua conta SkyHub
X-Accountmanager-Key: token_account único de cada Plataforma/ERP 

Todos os parâmetros acima são informados durante o envio da conta teste e são obrigatórios para efetuar as requisições, ou seja, somente plataformas/ERPs em processo de homologação/homologados possuirão esses dados.

Se você/seu sistema não possui ainda uma homologação com a API da Americanas, deverá solicitar entrando em contato conosco.

Formato dos dados

Na troca de mensagens com a API da Americanas, será utilizado o padrão JSON (JavaScript Object Notation). Por isso, cada requisição deve conter os valores adequados nos cabeçalhos Accept e Content-Type (application/json).

# Headers do formato de dados
Accept: application/json
Content-Type: application/json

Encoding (charset)

Os dados enviados (via POST ou PUT) devem estar de acordo com o charset UTF-8.

Caso seja utilizado um encoding diferente, será retornado o erro de "Tipo de dado não suportado" (HTTP 415).

[IMPORTANTE] - Mesmo que o header "Accept" indique o uso do charset UTF-8, se os dados do body não estiverem no encoding correto, também será retornado o erro HTTP 415.

Como ficam os headers

--header 'X-User-Email: email_de_usuario' \
--header 'X-Api-Key: token_de_integracao de sua conta SkyHub' \
--header 'X-Accountmanager-Key: token_account único de cada Plataforma/ERP' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \