Bookkeep API V1
The Bookkeep API is intended to let you build functional applications and integrations, quickly and easily. The Bookkeep API is organized around REST, has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
Authentication
- HTTP: Basic Auth
- HTTP: Basic Auth
Used by every endpoint except the inventory endpoints (Purchase Orders, Suppliers,
Receipts and Bills), which use an API key instead. See the api_key scheme.
The Bookkeep API uses API keys to authenticate requests. You can view and manage your API keys in the Bookkeep Developer Dashboard. Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. Authentication to the API is performed via HTTP Basic Auth. Provide your Publishable key as the basic auth username value and your Secret key as the basic auth password value. All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
curl -L -X GET 'https://api.bookkeep.com/v1/entities' \
-H 'Authorization: Basic ZGlsaXAuYmFpcmFnaUBib29ra2VlcC5jbzpXLlM4NVZGbkJyeEY2QmI='
Security Scheme Type: | http |
|---|---|
HTTP Authorization Scheme: | basic |
Used by the inventory endpoints: Purchase Orders, Suppliers, Receipts and Bills.
Send your API key with HTTP Basic authentication: the key is the username, and the
password is ignored, so leave it empty or use a placeholder such as x. Requests must
use HTTPS.
Create and manage API keys under Settings → API keys in the Bookkeep section of the Bookkeep app. See the Inventory API overview for what each scope allows.
curl -L -X GET 'https://api.bookkeep.com/v1/entities/<entity_id>/purchase_orders' \
-u '<api-key>:x'
Security Scheme Type: | http |
|---|---|
HTTP Authorization Scheme: | basic |