Início rápido

O que você precisa para a primeira chamada à API REST da Climba e a ordem recomendada para desenvolver a integração.

Atualizado em

O que você precisa

  • A URL da API da loja e o token de acesso, enviados pela equipe da Climba. Para desenvolver, peça um ambiente de testes.
  • Um cliente HTTP. Os exemplos desta documentação usam curl; a referência da API mostra cada rota também em PHP, JavaScript e Python.

A API segue o padrão REST: GET consulta, POST cadastra, PUT atualiza o recurso inteiro, PATCH atualiza só uma parte e DELETE exclui. Todo o tráfego é feito por https e as respostas vêm em JSON com UTF-8.

Primeira chamada

Troque https://api.exemplo pela URL da API da loja e SEU_TOKEN pelo token. Esta chamada retorna os detalhes do pedido 50:

curl -X GET 'https://api.exemplo/api/v1/orders/50' \
  -H 'accept: application/json' \
  -H 'x-idcommerce-api-token: SEU_TOKEN'

E esta, os detalhes do produto 50:

curl -X GET 'https://api.exemplo/api/v1/products/50' \
  -H 'accept: application/json' \
  -H 'x-idcommerce-api-token: SEU_TOKEN'

Se a resposta for 401, confira o cabeçalho em Autenticação. Os outros códigos estão em Erros.

Ordem recomendada

A Climba recomenda desenvolver nesta ordem, do cadastro mais simples ao fluxo de pedidos:

  1. Marcas: o cadastro mais simples, bom para entender o funcionamento da integração.
  2. Atributos (cor, tamanho e outros grupos), que as variações dos produtos usam.
  3. Categorias, da categoria pai para as filhas.
  4. Produtos, com marca, atributos, categorias e as variações de estoque.
  5. Fotos dos produtos (opcional).
  6. Consulta de pedidos, por webhook ou por consulta periódica.
  7. Formas de pagamento, formas de envio e operadores logísticos (opcional), para relacionar com os do sistema.
  8. Aviso de pedido importado para a Climba.
  9. Faturamento do pedido.

Os detalhes de cada passo estão em Sincronização de produtos e pedidos. Para não reenviar cadastros, guarde no seu banco de dados o que já foi enviado para a Climba: assim você não repete o POST nem precisa de um GET para saber se o item já existe na loja.

Isso ajudou?