Autenticação
A autenticação das APIs do Marketplace é realizada obrigatoriamente com um client_id e um token, formando assim as informações do cabeçalho (header) das requisições. Os seguintes dados são esperados em cada requisição:
CLIENT_ID: Identificação da integradora. O código é gerado automaticamente ao criar uma nova App aqui, no portal desenvolvedores (Pode ser encontrado na coluna Token da lista de Apps). Seu valor é único e fixo para a usabilidade em homologação e também em produção.
ACCESS_TOKEN: Identificação do lojista, que dá acesso às informações da loja de um lojista específico. Sua criação em produção pode ocorrer automaticamente através do onboarding (o seller opta por sua integradora dentro de uma lista e automaticamente vinculamos o novo código ao client_id (App) do integrador) ou através de chamado.
Lembrando que, para proteção dos seus dados, todas as informações trafegadas nas APIs, são através de protocolo HTTPS. Clique aqui e conheça um pouco mais sobre a utilização do HTTPS.
Erros de Autenticação
Alguns erros serão tratados durante a autenticação da chave de acesso. Abaixo a lista dos erros:
-
Ausência de header: O client_id e o access_token devem ser passados em todas as requisições, obrigatoriamente. Caso um dos parâmetros esteja ausente, será retornado o erro 401 Unauthorized.
-
Inexistente/errado: Se qualquer um dos dados do header (client_id e/ou token) passados não existir ou estiver incorreto/ incompleto, será retornado o erro 403 Forbidden.
-
Tokens inativos (inválidos): Se o access_token estiver inativo ele será considerado inválido e retornará o erro 403 Forbidden*.
Para os erros de ausência de um dos dados do header e/ou token inexistente/errado, medidas podem ser tomadas do lado do desenvolvedor para validar se as informações que estão sendo passadas estão válidas. Para o erro de tokens inativo (inválido), é necessário entrar em contato com o time de Integrações.
Solicitação do access token para produção
Há 3 situações em que um token de produção pode ser gerado. Vejamos cada uma:
-
Onboarding (Entrada de novos sellers - mar aberto): Durante o cadastro, o próprio seller seleciona a integradora e já obtêm o token.
-
Solicitação de token (através de chamado): Para sellers que atuam de forma manual no Via Marketplace e decidem realizar a contratação de uma integradora, é necessário realizar a abertura de chamado. Clique aqui e abra um chamado.
-
Troca de Integração (através de chamado): Quando o seller já possui integração com a API, porém deseja realizar a troca do integrador. Clique aqui e abra o chamado.
