Pular para o conteúdo principal

API Pública do Cortecloud

O Cortecloud é a plataforma em que marceneiros, profissionais que projetam e montam móveis, encomendam peças cortadas sob medida a centrais de serviço, as empresas que vendem os materiais e produzem essas peças. Neste portal, "central" é sempre a central de serviço. Os demais termos estão definidos em Conceitos.

A API Pública permite integrar o sistema de uma central (ERP, sistema de vendas, checkout de pagamento) ao Cortecloud. Com ela, a sua integração pode:

  • manter preço, estoque e status ativo/inativo dos materiais da central: chapas, fitas de borda e componentes (Materiais);
  • consultar os serviços (pedidos) da central, associá-los aos pedidos do seu ERP e enviá-los para produção (Obter serviços e Atualizar serviços);
  • ser avisada a cada mudança de status de um serviço, sem consultar GET /services repetidamente (Webhooks);
  • receber o pagamento online de um serviço num checkout do seu sistema (Checkout de pagamento);
  • abrir telas do Cortecloud já autenticadas para vendedores e marceneiros, sem que eles digitem usuário e senha (Login embutido).

Para quem desenvolve software de projeto de móveis, o portal também documenta o formato do arquivo JSON com que o marceneiro importa peças, furações e usinagens para um serviço (Importação por arquivo JSON). Essa integração é feita por arquivo e não usa a API.

Ambientes​

AmbienteURL base
Homologaçãohttps://apis.hml.cortecloud.com.br
Produçãohttps://apis.cortecloud.com.br

Cada ambiente tem credenciais próprias. Os exemplos usam caminhos relativos (/services, /materials/boards): prefixe com a URL base do ambiente.

Primeiros passos​

  1. Peça as credenciais (api key e secret key) a suporte@serrabits.com.br. Informe que você é integrador, qual central vai integrar e em qual ambiente. Se não souber o código da central, peça-o na mesma mensagem.
  2. Implemente a assinatura das requisições seguindo Autenticação e confira o resultado com os valores de validação.
  3. Leia Erros, limites e paginação antes de escrever laços de sincronização.
  4. Siga o guia do seu caso de uso, primeiro em homologação e depois em produção.

Como esta documentação está organizada​

  • Guias (esta parte): conceitos, autenticação e o passo a passo de cada tipo de integração.
  • Referência da API: Swagger com todas as rotas, parâmetros, corpos e respostas. É a fonte de verdade sobre o formato de cada rota; os guias apontam para a operação correspondente.
  • Playground: coleção do Bruno com uma requisição de exemplo para cada rota, no ambiente de homologação. Aberta no Bruno, a coleção assina cada requisição sozinha. Para usá-la:
    1. abra a coleção no Bruno pelo botão "Open in Bruno";
    2. ative o Developer Mode do Bruno (o script de assinatura usa o módulo crypto);
    3. no environment HML, preencha apiKey e secretKey como secrets e companyInternalCode com o código da central.