canonical: https://jentic.com/apis/swaggerhub.bookaway/transfers-api # Bookaway Transfers API General Bookaway B2B API give you access to all Bookaway inventory. You can use it to search, book and get the status of a specific booking. Authentication To authenticate to Bookaway B2B API you need first to get credentials a `client_id` and a `client_secret`. Bookaway B2B API uses Oauth2 Client Credentials to perform the authentication. The Bookaway Oauth2 flow documentation is available [here]. The API exposes 16 endpoints secured with bearer authentication. ## For AI agents Programmatically access Transfers API resources. Covers 16 operations with bearer authentication. ## Scope Does not handle payments, communications, or crm - use for e-commerce only. ## Capabilities - Access Transfers API resources via REST API - Manage e commerce data programmatically - Integrate Transfers API into automated workflows - Query and filter Transfers API records by parameters - Monitor Transfers API operational status and events ## Use cases ### E-Commerce Operations The API provides 16 endpoints for e commerce operations. Example prompt: Execute a primary operation against the Transfers API ### Data Retrieval and Monitoring Query Transfers API resources on a schedule to track changes, generate alerts, or feed downstream dashboards. Agents poll relevant endpoints, compare against previous state, and trigger actions when thresholds are crossed. Example prompt: Poll the primary Transfers API endpoint, compare response to last known state, and alert if changed ### AI Agent Integration via Jentic AI agents discover and call Transfers API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle bearer tokens manually. Example prompt: Search Jentic for 'transfers API', load the operation schema, and execute with Jentic-managed credentials ## Key resources - **Approved** — Operations for approved - **Bookings** — Operations for bookings - **Cancelled** — Operations for cancelled - **Cities** — Operations for cities - **Credits** — Operations for credits ## Why Jentic - **Setup:** Wiring the Bookaway Transfers API by hand means learning its bearer-token auth, choosing between the stage and production Bookaway hosts, and handling retries yourself. Through Jentic you install once, import the Bookaway Transfers API from the API Directory, store the token once, and your agent calls it. - **Permission scoping:** This API is called with its target in the request body rather than a resource id in the URL path, so scope the agent to the operations it needs. The agent runs only the operations you allow. - **Credential handling:** Your Bookaway bearer token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'book a transfer', and Jentic returns the matching Bookaway operation with its input schema so the agent calls the right endpoint without browsing the reference docs. ## Related APIs - **Shopify** — Alternative e commerce API - **Stripe** — Alternative e commerce API ## FAQ ### What authentication does the Transfers API use? The Transfers API uses a Bearer token in the Authorization header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context. ### What are the rate limits for the Transfers API? Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer. ### How do I use transfers API through Jentic? Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'use transfers API'. Jentic returns the matching Transfers API operation with its input schema. Load the schema and execute the call - credentials are injected automatically. ### How many endpoints does the Transfers API have? The Transfers API exposes 16 endpoints covering approved, bookings, cancelled operations. ### Does the Transfers API support pagination? Pagination support depends on the specific endpoint. Check the endpoint parameters for page, limit, or offset fields. Through Jentic, the operation schema exposes all available parameters so agents can paginate automatically. ### Can I limit what my agent is allowed to do with the Bookaway Transfers API? Yes. Because you run Jentic One yourself, your own rules decide which Bookaway operations and credentials the agent may use. Since this API passes its target in the request body rather than a resource id in the URL path, you scope the agent by choosing exactly which operations it can call, so you can let it search inventory and check booking status while withholding the ability to create or cancel bookings. The agent runs only the operations you allow.