BAPP Auto API Client — Python

Official Python client for the BAPP Auto API. Provides a simple, consistent interface for authentication, entity CRUD, and task execution.

Getting Started

1. Install

pip install bapp-api-client

2. Create a client

from bapp_api_client import BappApiClient

client = BappApiClient(token="your-api-key")

3. Make your first request

# List with filters
countries = client.list("core.country", page=1, search="Romania")

# Get by ID
country = client.get("core.country", "42")

# Create
new = client.create("core.country", {"name": "Romania", "code": "RO"})

# Update (full)
client.update("core.country", "42", {"name": "Romania", "code": "RO"})

# Patch (partial)
client.patch("core.country", "42", {"code": "RO"})

# Delete
client.delete("core.country", "42")

Authentication

The client supports Token (API key) and Bearer (JWT / OAuth) authentication. Token auth already includes a tenant binding, so you don't need to specify tenant separately.

# Static API token (tenant is included in the token)
client = BappApiClient(token="your-api-key")

# Bearer (JWT / OAuth)
client = BappApiClient(bearer="eyJhbG...", tenant="1")

Configuration

tenant and app can be changed at any time after construction:

client.tenant = "2"
client.app = "wms"

API Reference

Client options

Methods

Paginated responses

list() returns the results directly as a list/array. Pagination metadata is available as extra attributes:

• count — total number of items across all pages
• next — URL of the next page (or null)
• previous — URL of the previous page (or null)

File Uploads

When data contains file objects, the client automatically switches from JSON to multipart/form-data. Mix regular fields and files in the same call:

# File objects, byte strings, or tuples (filename, file) are auto-detected
client.create("myapp.document", {
    "name": "Report",
    "file": open("report.pdf", "rb"),
})

# Tuple form for explicit filename / content-type
client.create("myapp.document", {
    "name": "Report",
    "file": ("report.pdf", open("report.pdf", "rb"), "application/pdf"),
})

# Also works with tasks
client.run_task("myapp.import_data", {
    "format": "csv",
    "file": open("data.csv", "rb"),
})

Document Views

Records may include public_view and/or view_token fields with JWT tokens for rendering documents (invoices, orders, reports, etc.) as HTML, PDF, or images.

The SDK normalises both formats and builds the correct URL automatically:

order = client.get("company_order.order", "42")

# Get a PDF download URL (auto-detects public_view vs view_token)
url = client.get_document_url(order, output="pdf")

# Pick a specific view by label
url = client.get_document_url(order, output="html", label="Comanda interna")

# Use a variation (e.g. for different report periods)
url = client.get_document_url(order, output="pdf", variation="v4")

# Fetch the actual content as bytes
pdf_bytes = client.get_document_content(order, output="pdf")
with open("order.pdf", "wb") as f:
    f.write(pdf_bytes)

# Enumerate all available views
views = client.get_document_views(order)
for v in views:
    print(v["label"], v["type"], v.get("variations"))

get_document_views() returns a list of normalised view entries with label, token, type ("public_view" or "view_token"), variations, and default_variation. Use it to enumerate available views (e.g. for a dropdown).

Tasks

Tasks are server-side actions identified by a dotted code (e.g. myapp.export_report).

# List all tasks
tasks = client.list_tasks()

# Inspect a task
cfg = client.detail_task("myapp.export_report")

# Run without payload (GET)
result = client.run_task("myapp.export_report")

# Run with payload (POST)
result = client.run_task("myapp.export_report", {"format": "csv"})

Long-running tasks

Some tasks run asynchronously on the server. When triggered, they return an id that can be polled via bapp_framework.taskdata. Use run_task_async() to handle this automatically — it polls until finished is true and returns the final task data (which includes a file URL when the task produces a download).

License

MIT