Neste tópico iremos abordar quais são os Headers, Parâmetros e o formato necessários para integrar com a API. Importante seguir todas as instruções para que a requisição ocorra com sucesso.
Todas as chamadas aos serviços disponíveis na API devem ser autenticadas a partir do appKey e appToken, informação que autentica o Marketplace. Essas informações devem ser enviadas no cabeçalho (header) de cada requisição conforme abaixo:
Todos os parâmetros acima são informados durante o cadastro 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 Fast Shop, deverá solicitar entrando em contato conosco.
Todas as vezes em que o Seller fizer uma ação de consultar ou criar algum dado em sua plataforma, nós informaremos os headers de autenticação.
Na pratica, todas as vezes em que o Seller fizer as seguintes ações:
Notificação de Catálogo
Registro de Catálogo
Atualização de Catálogo
Atualização de Status do Pedido
Caso o Marketplace tenha a necessidade de alterar os nomes dos parâmetros de autenticação nas chamadas feitas pelo Seller devido a uma restrição em sua aplicação, é possível ser alterado. Caso necessário entre em contato Conosco.
Formato dos dados
Na troca de mensagens com a API, será utilizado o padrão JSON (JavaScript Object Notation). Por isso, cada requisição deve conter os valores adequados nos cabeçalhos "Accept", "Content-Type" (application/json), "Content-Length" que será o tamanho do body do request em bytes, e o "Host" com a URL base da API de integração que esta disponível em "".
Headers do formato dos dados:
Accept: application/json
Content-Type: application/json
Content-Length: {{tamanho do body do request em bytes}}
Host: {URL base da API de integração}}
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.