Princípios básicos

Bem-vindo ao guia da API dos e-commerces da Betalabs! Usando esta API que você conseguirá personalizar o template da sua loja para fluxos customizados às suas necessidades.
A seguir, algumas convenções da nossa API:

Quando usar a API para o e-commerce

A API do e-commerce serve para as requisições dentro do contexto da loja onde cada requisição utiliza dados da sessão do usuário que está acessando a loja para validar, enviar ou requisitar dados para a plataforma.
Com esse comportamento, essa é uma API que guarda estado entre as requisições, ou seja, ao adicionar um item ao carrinho, por exemplo, o mesmo é persistido na sessão e, em uma próxima requisição, esse item constará na sessão para consulta ou manipulação, até que essa sessão seja encerrada pelo fluxo natural da aplicação.
Além disso, por ser destinada ao e-commerce, ela possui travas de segurança e funcionalidades específicas voltadas aos fluxos das lojas.

Endpoint base

Na API do ecommerce as chamadas devem ser direcionadas ao dominio da loja e deverão ser dinâmicas entre os domínios de homologação (padrão nome-do-projeto.store.betalabs.net) e de produção.
Para isso, use endpoints relativos nas chamadas, iniciando em "/", e o próprio JavaScript se encarregará de incluir o hostname relativo à página que estiver sendo acessada no momento da requisição.

Autenticação

Como obter o seu access token

Na API do e-commerce nem todas as rotas exigem um access token. Nas que exigem, o access token deverá ser obtido a partir de um login com e-mail e senha de um cliente da loja e representará esse cliente nas demais requisições.
Após o login ser feito com sucesso e o token persistido na sessão do usuário, o plugin canopus é responsável por armazenar o token em si para facilitar os demais fluxos e você poderá consultá-lo a qualquer momento utilizando o método OauthService.getToken().

Como usar o seu access token

Informe o seu access token nas suas requisições como valor do cabeçalho da requisição Authorization e com o prefixo Bearer. Exemplo: "Bearer <<seu access token>>".

Códigos de resposta

Nossa API usa como retorno os códigos HTTP padrão para indicar tanto o sucesso de uma requisição, quanto para indicar falha. Segue: