Referência da API

213 operações, geradas.

Nada nestas páginas é escrito à mão. Elas são derivadas dos mesmos artefatos OpenAPI contra os quais nossos próprios serviços são construídos, que são regerados a partir das tabelas de rotas em execução e comparados byte a byte em cada pull request, então esta referência não consegue descrever um endpoint que não se comporta mais assim.

O texto do contrato está em inglês

As páginas são em português. O que vem dos artefatos permanece como está: os resumos, as descrições de campo e os nomes de esquema são as palavras da própria API, escritas onde ela é escrita e conferidas byte a byte contra ela. Traduzi-los aqui deixaria o site e o contrato livres para discordar, e são justamente os nomes que você digita no seu código.

URL base

https://api-sbx.sonacore.com.br

Caminhos

189

Operações

213

Especificação

OpenAPI 3.1

Baixe as especificações

As especificações legíveis por máquina são servidas como arquivos estáticos, com a URL do servidor e o esquema de segurança que os artefatos gerados omitem já aplicados, então elas servem para geração de cliente como estão.command-api.json 0.2.0 query-api.json 0.5.0

E os seus próprios produtos

Esta página é o contrato da plataforma, e ele é o mesmo para todo mundo — por isso as rotas de produto documentam a forma de uma chamada e nunca enumeram ações: as ações são dados de um tenant. Os seus produtos é o mesmo documento gerado a partir dos seus manifestos, com cada ação como uma operação de corpo tipado — e um cliente Python gerado dele. Precisa de uma credencial; as rotas continuam sendo as daqui.

Quadra Command API

Command ingestion API for Quadra ledger operations. Versão 0.2.0, 121 caminhos, 141 operações. Ver todas as tags.

Quadra Core API

API for Quadra Core ledger. Versão 0.5.0, 68 caminhos, 72 operações. Ver todas as tags.

Convenções

Todo caminho é versionado sob /v1. Escritas que criam valor exigem um cabeçalho Idempotency-Key. Valores são inteiros na unidade menor da moeda, centavos, nunca uma string decimal, e uma moeda é um código de três letras.

valor

{ "currency": "BRL", "value": 12000 }   // R$ 120,00

Dois códigos de status para esperar em vez de depurar: criar uma parte devolve 200 enquanto criar uma conta devolve 201. Isso é inconsistente e é o contrato.

← Eventos e webhooks Próximo: Playground →