ShiwakeDocs

API Reference

HTTP endpoints exposed by the Shiwake multi-tenant ledger engine.

Shiwake exposes a versioned REST API over HTTPS. Every endpoint accepts and returns JSON, is authenticated per tenant, and wraps its payload in a standard envelope so clients can parse successes and failures the same way.

Base URL

https://api.shiwake.example.com/api/v1

The API is split into two top-level namespaces:

NamespacePurposeAuth
/api/v1/ledger/...Tenant-scoped ledger operations: accounts, entries, holds, reconciliationAPI key (TenantAccess)
/api/v1/platform/...Platform-admin operations: tenant CRUD, API key rotationBearer token (PlatformAdmin)

The version segment (v1) is part of the URL. There is only one version today; future breaking changes will be published under v2 and both will coexist during the deprecation window.

Content type

All request bodies must be application/json. Responses are always application/json, even for errors.

Response envelope

Every response (success or failure) is an ApiResponse<T> with three fields:

{
  "code": 200,
  "message": "Retrieved successfully",
  "data": { /* resource payload */ }
}

Prop

Type

The code field always matches the HTTP status of the response. Clients can rely on either; the SDK uses it to decide whether to throw.

Resources

Edit on GitHub

Last updated on

On this page