API Endpoints #

This document provides an overview of the main API endpoints available in BonsAPI.

Authentication #

Authenticates a user and returns a JWT token.

Request:

{
  "email": "user@example.com",
  "password": "password"
}

Response:

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "expires_at": "2023-12-31T23:59:59Z"
}

Refreshes an existing JWT token.

Returns a list of entities the user has access to.

Returns details for a specific entity.

Creates a new entity.

Updates an existing entity.

Uploads a document for processing.

Retrieves information about a specific document.

Lists documents for the authenticated user or specified entity.

Extracts data from an invoice document.

Retrieves information about a specific invoice.

Lists invoices for the authenticated user or specified entity.

Lists available integrations.

Connects to a third-party service.

Checks the status of an integration.

Retrieves settings for a specific entity.

Updates settings for a specific entity.

All endpoints follow a consistent error response format:

{
  "error": {
    "code": "ERROR_CODE",
    "message": "Human-readable error message",
    "details": { ... }
  }
}

Common HTTP status codes: