A API REST fornece aos seus sistemas próprios os mesmos dados que sua equipe vê no TradeCatalog: produtos, preços dos clientes, clientes, pedidos, mudanças de preços e o log de atividades. Ela usa JSON sobre HTTPS e uma chave de API por sistema.
URL baseLink para esta seção#
https://tradecatalog.app/api/v1
Toda requisição precisa de uma chave de API no cabeçalho Authorization. Veja Autenticação.
Quem pode usá-loLink para esta seção#
- Proprietários e administradores criam e revogam chaves. Outros funcionários e compradores não podem.
- O workspace precisa de uma entidade Pro ou de uma conta de pilotagem para criar chaves.
- Workspaces de demonstração não podem usar a API de forma alguma.
- Quando o Pro termina, o workspace retorna para Free: as chaves de API existentes ainda podem ler, mas não podem gravar. Edições no catálogo e pedidos de compradores no app continuam funcionando.
Uma chave pertence a um único workspace. Ela age com as permissões da pessoa que a criou, então uma chave de proprietário ou administrador pode ver os preços de todos os clientes. Se essa pessoa sair do workspace, a chave deixará de funcionar.
Pontos finaisLink para esta seção#
| Método | Caminho | O que ele faz | Escopo |
|---|---|---|---|
| GET | /workspace | O workspace ao qual esta chave pertence | leitura |
| GET | /products | Lista ou pesquisa produtos, opcionalmente com preços de um cliente | leitura |
| GET | /products/{id} | Um produto com seu preço | leitura |
| PUT | /products | Cria ou atualiza até 100 produtos por SKU | escrita |
| GET | /brands | Todos os marcas | leitura |
| GET | /categories | Todas as categorias | leitura |
| GET | /prices | O que um cliente paga por um SKU, e por quê | leitura |
| GET | /customers | Clientes comerciais | leitura |
| GET | /customers/{id} | Termos, regras, preços acordados e compradores de um cliente | leitura |
| PUT | /customers | Cria ou atualiza até 100 clientes | escrita |
| GET | /orders | Pedidos recentes, do mais novo para o mais antigo | leitura |
| GET | /orders/{id} | Um pedido com linhas e histórico de status | leitura |
| PATCH | /orders/{id} | Avança um pedido | escrita |
| GET | /price-changes | Mudanças de preços, do mais novo para o mais antigo | leitura |
| GET | /price-changes/{id} | Visualização de uma mudança de preço | leitura |
| GET | /activity | Quem alterou o quê | leitura |
A descrição completa e de leitura automática está em /api/v1/openapi.json.
Antes de começar a desenvolverLink para esta seção#
- Leia Convenções sobre dinheiro, paginação, datas e como
PUTfunciona. - Leia Erros sobre códigos de status e tentativas de novo.
- Mantenha as chaves no seu servidor. A API não permite solicitações de navegador (CORS).
Ainda não disponível na APILink para esta seção#
- Webhooks: faça poll em
GET /orders?status=newem vez disso. - Publicação, agendamento ou cancelamento de mudanças de preço: faça isso no app.
- Regras de desconto e preços acordados: leia-os com
GET /customers/{id}, altere-os no app. - Exclusão de produtos ou clientes, upload de imagens diretamente, convite de compradores, colocação de pedidos como comprador.