Documentação
Um ledger de obrigações, e como chamá-lo.
O Sona Core registra dinheiro como objetos discretos com dono, e não como linhas em uma tabela de saldos. Cada unidade de valor carrega o próprio dono, a própria origem e a regra sob a qual ela se move, e um saldo é uma soma sobre esses objetos, não um número que alguém atualiza. Estas páginas descrevem o que isso significa para quem integra, e a referência abaixo é gerada a partir dos mesmos artefatos de contrato contra os quais nossos serviços são construídos.
URL base
https://api-sbx.sonacore.com.br
Caminhos documentados
189
Operações
213
Autenticação
OAuth2 client credentials
O que está aqui, e o que não está
Publicamos a superfície da API, as garantias de consistência, o modelo de autorização e os contratos de eventos, porque uma afirmação de verificabilidade que não está especificada publicamente é só uma afirmação. Não publicamos nossos registros internos de decisão, a topologia do parque que roda isso, nem quem mais tem credencial.
Essa linha é traçada de propósito, e não é gosto de cada página. O que vem abaixo é ela inteira:
| Área | O que publicamos, e o que não |
|---|---|
| A API | Cada caminho, parâmetro, esquema de requisição e resposta declarada, gerados a partir dos artefatos de contrato. Mais os arquivos de especificação para baixar. |
| Garantias | O modelo de consistência contra o qual quem integra precisa programar, incluindo as anomalias. Não o inventário interno de grupos de escrita, nem o arcabouço de testes atrás dele. |
| Autorização | A taxonomia de escopos, o modelo de confiança na borda e a regra de responder 404 antes de 403. Não a lista de qual cliente tem qual concessão. |
| Eventos | O envelope, o inventário de eventos, o esquema de assinatura dos webhooks e os vetores de teste dele. Não as chaves físicas de armazenamento das quais os eventos são derivados. |
| Fora daqui | Registros de decisão, material de custo e de roteiro, a topologia interna do parque, e qualquer coisa que nomeie outro cliente. |
Duas APIs, um ledger
O lado de escrita e o lado de leitura são serviços separados, com contratos separados. Qual dos dois responde por um caminho não é sempre o que o nome sugere: criar uma parte ou uma conta é escrita, mas as duas moram no serviço de leitura, e /v1/squads está dividido entre os dois por método. A referência é organizada por serviço e por tag justamente para você nunca precisar adivinhar.
| Serviço | Versão | Superfície |
|---|---|---|
| Quadra Command API | 0.2.0 | 121 caminhos, 141 operações, 16 tags. Command ingestion API for Quadra ledger operations |
| Quadra Core API | 0.5.0 | 68 caminhos, 72 operações, 19 tags. API for Quadra Core ledger |
Por onde começar
- Conceitos, se você nunca modelou dinheiro como objeto. É o caminho mais curto para ler uma resposta corretamente.
- Garantias, antes de escrever um cliente. Diz quais leituras são read-your-writes e por que
FINALnão significa liquidado. - Autenticação, quando você já tem credencial e quer chamar o ambiente de avaliação em vez de ler sobre ele. Os roteiros de demonstração percorrem as mesmas chamadas de ponta a ponta, com os corpos escritos por extenso.