API de Integração Likin.do (1.0.29)

A API do Likin.do utiliza o padrão de autenticação OAuth2, conforme descrito na RFC 6750 e detalhado em https://oauth.net/2.

O acesso à API é fornecido mediante a inclusão prévia da matriz (franqueadora) e de suas lojas (franqueados), cada um destes possuindo seu próprio conjunto de chaves de acesso, denominados Client ID e Client Secret, os quais funcionam como usuário e senha da matriz ou loja.

Estas chaves são a base para a geração dos tokens de acesso (access tokens), e sem elas não é possível utilizar a API.

Em caso de dúvidas contatar o suporte da Likin.do.

Para acessar a API do Likin.do, todos os endpoints exigem um token de acesso (access token) do tipo Bearer no cabeçalho Authorization da requisição, conforme padrão OAuth2.

Authorization: "Bearer access_token"

O access token deve ser obtido através de uma requisição ao Authorization Server do Likin.do, enviando um Client ID e um Client Secret válidos, conforme descrito no endpoint Create Access Token do OAuth2.

O Authorization Server retornará um destes dois tipos de access token:

• Access token da matriz (franqueadora): Obtido quando fornecido ao Authorization Server um Client ID e um Client Secret de uma matriz.
• Access token da loja (franqueado): Obtido quando fornecido ao Authorization Server um Client ID e um Client Secret de uma loja.

A API possui endpoints separados em 3 níveis distintos de permissão:

• Endpoints exclusivos da matriz (somente acessíveis utilizando o access token da matriz).
• Endpoints exclusivos da loja (somente acessíveis utilizando o access token da loja).
• Endpoints não exclusivos (acessíveis utilizando qualquer access token, seja da matriz ou da loja).

Além de definir quais endpoints são permitidos, o access token também define de qual matriz/loja os dados serão retornados, criados, atualizados ou excluídos.

Status Code

200

Campos:

• data: Objeto ou Array contendo o resultado da requisição GET. Para requisições POST, PUT e DELETE retorna um Objeto vazio: {}.

Exemplo

{
    data: {}|[]
}

Status Code

400, 401, 403, 404 ou 500

Campos

• code: Constante numérica do erro.
• type: Constante textual do erro.
• message: Descrição human-readable do erro.
• properties: Retornando somente para erros do tipo invalid_property. Contém as propriedades JSON inválidas e as descrições dos motivos de invalidação.
• parameters: Retornando somente para erros do tipo invalid_parameter. Contém os parâmetros de URL inválidos e as descrições dos motivos de invalidação.

Exemplo

{
    "error": {
        "code": 1401,
        "type": "invalid_property", 
        "message": "Propriedade(s) inválida(s).",
        "properties|parameters": [
            {
                "name": "variation",
                "message": "Tipo 'boolean' obrigatório."
            }
        ]
    }
}

Create

• Os endpoints CREATE retornam um Objeto contendo a própria entidade criada.

Update

• Todos as propriedades informadas ao UPDATE são opcionais, portanto devem ser informadas somente as propriedades que serão alteradas.
• Os endpoints UPDATE retornam um Objeto contendo a própria entidade modificada.

Delete

• Os endpoints DELETE não retornam a entidade excluída, devendo portanto ser verificado o HTTP Status Code da resposta para validar o sucesso da exclusão.

Get

• Os endpoints GET retornam um Objeto ou uma Lista de Objetos contendo a(s) entidade(s) requisitadas conforme padrão de retorno de sucesso.

Atributos

Os atributos descrevem características de um produto que podem variar. Estes podem ser coisas como cor, tamanho, estilo, peso, dimensões, entre outros. No contexto de variações de produtos, esses atributos servem para criar diferentes variantes de um produto base.

Vamos considerar um exemplo simples: uma camiseta. Uma camiseta pode ter atributos como cor, tamanho, material e estilo. Assim, um único produto (a camiseta) pode ter várias variações (por exemplo, uma camiseta de algodão preta de tamanho grande com um estilo de gola V).

Nos endpoints, temos:

1. /attribute/group: Este endpoint lista os grupos de atributos. Cada grupo pode conter um ou mais atributos, e seu objetivo é diferenciar atributos de mesmo nome porém com aplicações diferentes. Como por exemplo um atributo "Cor" utilizado para Móveis de um atributo "Cor" utilizado para eletrodomésticos. Ambos possuem o mesmo nome porém a sua lista de cores será diferente.

2. /attribute: Este endpoint lista os atributos.

3. /attribute/{id_attribute}/option: Este endpoint retorna as opções de um atributo específico.

4. /attribute/value/product/{id_product}: Este endpoint lista os atributos de um produto, bem como o valor (opção selecionada) para cada um destes atributos.

5. /attribute/value/product/variation/{id_product_variation}: Este endpoint lista os atributos de uma variação de produto, bem como o valor (opção selecionada) para cada um destes atributos.

Produtos configurados como variáveis (campo "variable" igual a "true") podem possuir atributos sem valor, neste caso o valor destes atributos é definido nas variações do produto. Por exemplo:

Produto: Camiseta
  Atributo: Tecido / Valor: Algodão
  Atributo: Cor / Valor: -
  Variação 1:
    Atributo: Cor / Valor: Branca
  Variação 2:
    Atributo: Cor / Valor: Preta

Quando o consumidor efetuar a compra, ele definirá qual valor deseja para cada atributo variável, definindo assim qual variação do produto (sku) será efetivamente comprada.

Os atributos são essenciais para a criação de variações de produtos, pois permitem aos clientes selecionar o produto exato que desejam, com base em suas preferências ou necessidades.

Atributos utilizados em Produtos, como por exemplo "Cor", "Tamanho", "Voltagem", etc. Cada atributo tem um ID único, um nome e está vinculado a um ID de grupo de atributos específico.

Grupos para os atributos que normalmente são utilizados em um mesmo tipo de produto, contudo a sua organização pode ser de livre escolha pelas marcas. Cada grupo de atributos possui um ID único e um nome associado, que podem ser usados para referenciar e identificar o grupo.

Opções de um atributo, como por exemplo as opções "Azul", "Branco" e "Preto" para o attributo "Cor". Cada opção de atributo tem um ID único, um ID de atributo associado e um valor.

Representa o vínculo de um Produto ou de uma Variação de Produto (SKU) com um determinado atributo e o seu valor (opção).

O valor (opção) do atributo é opcional para produtos e obrigatório para variações de produto (SKU). Quando o valor do atributo não for informado para um produto, então ficará a cargo do consumidor escolher o seu valor no momento da compra.

Exemplo

Produto: "Aspirador de pó".

Valores de atributos:

• Atributo "Cor" com o valor "Preto".
• Atributo "Voltagem" sem valor informado (variável).

Variações (SKUs) deste Produto:

• Variação de produto 1 (SKU "LKN-1") com o atributo "Voltagem" com o valor "110V".
• Variação de produto 2 (SKU "LKN-2") com o atributo "Voltagem" com o valor "220V".

No caso acima o produto "Aspirador de pó" será sempre vendido na cor "Preto", porém ficará a cargo do consumidor decidir a voltagem (e consequentemente o SKU). Por este motivo o atributo "Voltagem" não possui valor específico no Produto, mas possui valor em cada uma de suas variações (SKUs).

Cada valor de atributo tem um ID único, um ID de atributo associado, um ID de opção de atributo (quando aplicável), um ID de produto e um ID de variação de produto (quando aplicável).