Workspaces

API

API keys, request logs, bot messages and webhooks for the BRAccount integration API.

In detail

API is the workspace for the BRAccount integration API: BRAccount API Key to issue brk_ keys with scopes, API Log showing every request, Ledger Bot Message holding the Telegram ledger bot's drafts, and Ledger Automation Settings. Developers and the owner reviewing bot drafts use it. Creating a brk_ key for the Telegram bot is the typical task. Anything posted through the API lands in the same ledger and syncs to CBMS like a hand typed entry, so keys should be scoped narrowly and rotated when staff change.

How to record it in BRAccount

  1. 01Go to API from the sidebar.
  2. 02Click BRAccount API Key > New, name the client, pick the scopes and save.
  3. 03Copy the brk_ key once; it is not shown again.
  4. 04Open API Log to see requests, status codes and the user behind each.
  5. 05Open Ledger Bot Message to review drafts before they become Journal Entries.
  6. 06Disable a key immediately if it leaks.

When to use it

For developers connecting external apps to your books.

Example from the demo books

Create a brk_ key for the Telegram bot.