Autenticação

Para utilizar todos os recursos da API de vitrines, existem duas formas de autenticar as requisições:

Via Frontend

Essa autenticação é uma forma segura e que evita a necessidade de especificar dados sigilosos nas requisições. Utilize para requisições feitas pelo seu navegador.

Se você definir que o domínio .minhaloja.com está liberado para acessar nossa API, toda requisição para esse domínio será autenticada internamente. Removendo a necessidade de informar campos de autenticação. Facinho, facinho. 🍰

Para garantir essa segurança, precisamos que todos os hosts habilitados a consultar a API sejam fornecidos para nossa equipe de atendimento.

Para este tipo de autenticação, o parâmetro apiKey é opcional, porém recomendado. Enviar a apiKey, ajuda a validar a autenticidade da requisição.

CURL
curl --request GET \
  --url 'https://recs.chaordicsystems.com/v0/pages/recommendations?name=home&source=desktop&deviceId=<device-id>&apiKey=<my-api-key>' \
  --header 'origin: https://www.minhaloja.com.br/'

Via Backend

Quando as chamadas não forem feitas a partir do seu navegador, use a autenticação via chaves de apiKey e secretKey. Estas chaves são responsáveis por identificar sua loja na nossa plataforma (apiKey) e autenticá-la por um código de segurança (secretKey).

Nas requisições da API, esses dois campos devem ser informados via parâmetros de consulta, ou então devem ser especificados no header da requisição:

By Query Param
curl --request GET \
  --url 'https://recs.chaordicsystems.com/v0/pages/recommendations?name=home&source=desktop&deviceId=<device-id>&apiKey=<my-api-key>&secretKey=<my-secret-key>'
By Header
curl --request GET \
  --url 'https://recs.chaordicsystems.com/v0/pages/recommendations?name=home&source=desktop&deviceId=<device-id>' \
  --header 'x-api-key: <my-api-key>' \
  --header 'x-secret-key: <my-secret-key>'
Table of Contents