APIs e Microsserviços

29 jan, 2016

Como funciona a API SkyHub na integração entre marketplace e ERP

Publicidade

Já faz alguns anos que o e-commerce passou a adotar, de forma efetiva, o marketplace como uma excelente oportunidade de negócios. Mas quando essas lojas procuravam por integração, um problema comum encontrado por desenvolvedores sempre foi a compatibilidade com as diferentes APIs de cada marketplace.

Uma solução é a SkyHub, que possui uma API flexível para que a integração esteja adequada com a estrutura de sua plataforma ou ERP, utilizando tecnologias bem conhecidas no mercado, como REST e JSON. Essa API, além de facilitar a instalação, permite ter em uma única ferramenta a análise de performance em cada um dos marketplaces em que a loja está inserida.

Existem diversos recursos que a ferramenta da SkyHub oferece para os parceiros. Você pode conferir uma lista delas:

  • Integração de estoque único: é possível ter a informação de todo o estoque do sistema da loja, gerenciado-o em diferentes marketplaces.
  • Manutenção das APIs dos marketplaces: as APIs dos marketplaces estão em constante evolução; para que o dono do negócio não tenha que realizar as atualizações constantemente, elas são realizadas pela própria SkyHub.
  • Possibilidade de escalar o negócio: por ser um Hub, que tem como objetivo principal concentrar todos os canais de marketplace em um local só, é possível escalar o negócio de maneira muito mais simples, pois a integração com novos marketplaces depende apenas de uma ativação no sistema, sem necessidade de novas alterações no sistema integrador.
  • Fluxo de pedidos sem alteração: por meio do integrador, o fluxo de pedidos que o e-commerce possuía antes de estar inserido nos marketplaces se mantém o mesmo.
  • Gestão de produtos e preço: a gestão de quais produtos colocar em cada marketplace, além da definição de preço também é feita via SkyHub, facilitando o processo gerencial.
  • Criação de atributos: a criação de atributos pode ser toda feita dentro da SkyHub, acelerando a subida para o marketplace.

Neste artigo, vamos mostrar como fazer alguns dos principais comandos da ferramenta para exemplificar a facilidade de integração da API SkyHub.

Qual o funcionamento da API SkyHub?

Antes de mostrar alguns dos principais comandos da plataforma no momento da integração, abaixo você pode ver o painel que auxilia com alguns das principais ações disponíveis na API SkyHub:

skyhub-1

Para iniciar o processo de integração entre sua loja virtual e o marketplace, é necessário realizar a autenticação das informações do ERP. Essa autenticação é realizada por meio do e-mail do usuário cadastrado (que fica a critério da empresa) aliado ao token, fornecido pela SkyHub.

A comunicação se dá por meio do padrão JSON (JavaScript Object Notation/Notação de Objetos JavaScript), que é um formato leve de troca de dados que facilita a leitura para o usuário e a interpretação das informações por parte do servidor. Na prática, as requisições precisam apresentar os valores correspondentes em: Accept e Content-Type (application/json).

Alguns dos erros mais comuns

  • Código do status: 401 – Unauthorized (Não autorizado):
    1. O cabeçalho (header) da requisição não contém os dados de acesso (ou estão errados): 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.

Funções disponíveis na API SkyHub

Apresentamos exemplos de algumas funções disponíveis na API SkyHub e como elas podem ser utilizadas na prática:

Paginação: Uma dificuldade latente no processo de integração é com relação aos resultados obtidos nas consultas do pedido e também dos produtos. Faz-se necessário desenvolver os seguintes itens:

  • Page: mostra a página que será retornada. Por padrão, sempre será a página 1 caso você não configure.
  • Per_page: a quantidade de registros retornados.

No link abaixo apresentamos o modelo que devolve a página 2, com páginas de 100 na API SkyHub: GET https://in.skyhub.com.br/products?page=2&per_page=100

As informações de página (o nº 2 do exemplo) e da quantidade de registros retornados (o nº 100 do exemplo) podem ser alteradas de acordo com os critérios que você definir, facilitando todo o processo de paginação.

Configurações de produto: Para configuração de produtos, será utilizado o endpoint https://in.skyhub.com.br/products, tanto para produtos simples quanto produtos que trabalham com variáveis. O único diferencial será a estrutura dos dados na chamada. É preciso que o desenvolvedor se atente para isso.

Para produtos com variações de preço, é preciso apresentar alguns elementos como:

  • variations – os dados referentes às variações do produto em questão devem estar devidamente preenchidos;
  • variation_attributes – deve conter os nomes dos atributos que definem as variações (ex.: um produto que varia por cor e tamanho deve estar preenchido com [“cor”,”tamanho”]);
  • variations[specifications] – deve conter, dentre outros, os atributos especificados em variation_attributes (no estilo chave-valor).

Apresentamos alguns aspectos da API SkyHub e como ela pode ser configurada para que você realize a integração com os principais marketplaces do mercado. Existem outras aplicações possíveis dentro da API da SkyHub, e você pode verificar todas elas no link: http://in.skyhub.com.br/api-explorer/.