Ambientes
Ambiente de testes, homologação e produção: como desenvolver e testar a integração com a API REST da Climba.
Atualizado em
Ambiente de testes
Durante o desenvolvimento, a integração usa um ambiente de testes, com a estrutura da loja e um token próprio, para simular o fluxo sem mexer numa loja em produção.
Para pedir, preencha o formulário de pedido escolhendo "Ambiente de testes". O Suporte da Climba responde no e-mail informado no formulário com os dados de acesso.
Ferramentas para testar
Qualquer cliente HTTP serve para testar as chamadas antes de escrever o código da integração: curl, como nos exemplos desta documentação, ou um cliente com interface, como o Insomnia. Monte a requisição com a URL da API da loja de testes e o cabeçalho do token (veja Autenticação), envie o JSON e confira na resposta as validações ou a confirmação do cadastro.
curl -X POST 'https://api.exemplo/api/v1/brands' \
-H 'accept: application/json' \
-H 'content-type: application/json' \
-H 'x-idcommerce-api-token: SEU_TOKEN' \
-d @marca.json
O corpo de cada rota, com os campos obrigatórios, está na referência da API.
Homologação
Com o desenvolvimento pronto, a empresa responsável pelo sistema pede a homologação pelo mesmo formulário, escolhendo "Homologação da integração", e o Suporte da Climba responde no e-mail informado com as instruções. A homologação é uma série de testes práticos e perguntas; na integração por TXT, as regras estão em Homologação. Na API, a Climba confere:
- Atributos: cadastro de cor e tamanho e alteração do nome.
- Categorias: árvore de categorias, alteração e descrição. Categoria com categorias filhas não deve ter produtos.
- Marcas: cadastro, alteração do nome e descrição.
- Lista de preço: cadastro e alteração.
- Produtos: simples e com variações, em mais de uma categoria, com fotos, descrição, peso bruto em gramas e largura, altura e comprimento em centímetros, estoque e alteração das variações.
- Pedidos: importação de pedidos pagos, recebimento do status Cancelado, faturamento com o XML da nota e o relacionamento das transportadoras do sistema com as formas de envio da loja.
- Requisições: a quantidade de requisições e se a integração usa webhook.
Produção
A integração só é implantada na loja do cliente em produção depois que a Climba avisa, por e-mail, que ela está homologada. Para a implantação, o Suporte da Climba envia por e-mail os dados para configurar a integração no cliente em comum.