BAPP Auto API Client — Rust

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

Getting Started

1. Install

Add to Cargo.toml:

[dependencies]
bapp-api-client = "0.5.0"

2. Create a client

use bapp_api_client::BappApiClient;

let client = BappApiClient::new().with_token("your-api-key");

3. Make your first request

// List with filters
let countries = client.list("core.country", Some(&[("page", "1")])).await?;

// Get by ID
let country = client.get("core.country", "42").await?;

// Create
let data = serde_json::json!({"name": "Romania", "code": "RO"});
let created = client.create("core.country", Some(&data)).await?;

// Patch (partial update)
let patch = serde_json::json!({"code": "RO"});
client.patch("core.country", "42", Some(&patch)).await?;

// Delete
client.delete("core.country", "42").await?;

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)
let client = BappApiClient::new().with_token("your-api-key");

// Bearer (JWT / OAuth)
let client = BappApiClient::new().with_bearer("eyJhbG...").with_tenant("1");

Configuration

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

client.tenant = Some("2".to_string());
client.app = "wms".to_string();

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:

// Use request_multipart for file uploads
client.request_multipart(
    Method::POST,
    "/content-type/myapp.document/",
    &[("name", "Report")],        // text fields
    &[("file", "report.pdf")],    // file fields (field_name, file_path)
).await?;

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:

let order = client.get("company_order.order", "42").await?.unwrap();

// Get a PDF download URL (auto-detects public_view vs view_token)
let url = client.get_document_url(&order, "pdf", None, None);

// Pick a specific view by label
let url = client.get_document_url(&order, "html", Some("Comanda interna"), None);

// Use a variation
let url = client.get_document_url(&order, "pdf", None, Some("v4"));

// Fetch the actual content as bytes
if let Some(pdf_bytes) = client.get_document_content(&order, "pdf", None, None).await? {
    tokio::fs::write("order.pdf", &pdf_bytes).await?;
}

// Enumerate all available views
let views = BappApiClient::get_document_views(&order);
for v in &views {
    println!("{} {}", v["label"], v["type"]);
}

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).

let tasks = client.list_tasks().await?;

let cfg = client.detail_task("myapp.export_report").await?;

// Run without payload (GET)
let result = client.run_task("myapp.export_report", None).await?;

// Run with payload (POST)
let payload = serde_json::json!({"format": "csv"});
let result = client.run_task("myapp.export_report", Some(&payload)).await?;

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