BRAccount API Key
A key that lets another system read and write this company's books through the BRAccount API, stored hashed with scopes. No ledger effect itself.
In detail
A BRAccount API Key is a credential that lets another system, such as the Telegram ledger bot or a website, read and write this company's books through the BRAccount API. Each key starts with brk_, is shown once at creation and stored only as a hash, and carries scopes that limit it to reading, creating drafts or submitting documents. The key never posts anything on its own; the documents created through it post exactly as if a user had submitted them, and every call is written to BRAccount API Log. Give each integration its own key, so that revoking one does not stop the others, and rotate a key that may have leaked.
How to record it in BRAccount
- 01Go to API > BRAccount API Key > New.
- 02Name the integration, pick the company and the scopes it needs.
- 03Save. Copy the brk_ key shown once; it cannot be displayed again.
- 04Paste the key into the integration's configuration.
- 05Check API > BRAccount API Log for its first calls.
- 06To retire it, open the key and tick Revoked.
When to use it
Create under Nepal IRD > BRAccount API Key per integration; revoke it when that system is retired.
Example from the demo books
A brk_ key for the Telegram ledger bot with read and write scope.