API – Geral

Home » API – Geral

Autenticação

Todas as chamadas aos serviços disponíveis na SkyHub – API devem ser autenticadas a partir do e-mail do usuário e de um token de acesso. Essas informações devem ser enviados no cabeçalho (header) de cada requisição: X-User-Email e X-User-Token.

# Headers de autenticação
X-User-Email: email_de_usuario
X-User-Token: token_de_integracao

Como protocolo de transporte, recomenda-se o uso do HTTPS para garantir a segurança das informações de acesso. Para as chamadas realizadas sem a utilização do protocolo, a segurança das informações trafegadas são de responsabilidade única do usuário/desenvolvedor.

Formato de 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).

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

Paginação

A SkyHub – API, oferece a funcionalidade de paginação dos resultados obtidos nas consultas de pedidos e produtos. Para tal, basta especificar a faixa de registros a serem retornados pela API fazendo uso dos parâmetros:

  • page: indica o número da página de registros que será retornada. Caso não seja especificado, a primeira página será retornada (valor padrão 1);

  • per_page: indica a quantidade de registros a serem retornados;

Dependendo do recurso em questão, o parâmetro per_page possui configurações distintas de valor padrão e valor limite.

  • API de produtos: 100 valor padrão e valor limite;
  • API de pedidos: 30 valor padrão e 100 o valor limite;

No exemplo abaixo, a SkyHub – API retornará os produtos no intervalo de 101-200:

GET https://in.skyhub.com.br/products?page=2&per_page=100

Obs: não resultará em erro, caso o valor especificado em per_page ultrapasse o valor limite, apenas será retornada a quantidade limite de registros.

Erros

  • Código do status: 401 – Unauthorized (Não autorizado):

    1. O cabeçalho (header) da requisição não contém (ou estão errados) os dados de acesso: e-mail e/ou token;

    2. Um novo token foi gerado, mas não foi atualizado na aplicação.

  • Código do status: 403 – Forbidden (Proibido): a aplicação está tentando acessar um recurso ao qual não tem permissão;

  • Código do status: 406 – Not Acceptable (Não aceito): a SkyHub – API não suporta o formato de dados especificado no cabeçalho Accept.