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 Skyhub. 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 SkyHub – API devem ser autenticadas a partir do e-mail do usuário, token de acesso e accountmanager. Essas informações devem ser enviados no cabeçalho (header) de cada requisição conforme abaixo:
1
# Headers de autenticação
2
X-User-Email: email_de_usuario 
3
X-Api-Key: token_de_integracao de sua conta SkyHub
4
X-Accountmanager-Key: token_account único de cada Plataforma/ERP 
Copied!
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 essas informações.
Se você/seu sistema não possui ainda uma homologação com a SkyHub, deverá solicitar entrando em contato conosco. 
Formato dos dados
Na troca de mensagens com a SkyHub – API, 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).
1
# Headers do formato de dados
2
Accept: application/json
3
Content-Type: application/json
Copied!
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 juntos:
1
--header 'X-User-Email: SEU USUÁRIO' \
2
--header 'X-Api-Key: SEU TOKEN' \
3
--header 'Accept: application/json' \
4
--header 'x-accountmanager-key: SUA X-ACCOUNTMANAGER-KEY' \
5
--header 'Content-Type: application/json' \
Copied!
Se você ainda não possui essas informações, entre em contato com o nosso Time de API através do endereço de email [email protected].

Guias API SkyHub

Códigos de retorno (HTTP status)

Last modified 3mo ago

Copy link

Contents

Autenticação

Formato dos dados

Encoding (charset)