canonical: https://jentic.com/apis/qawafil.com/qawafil

# Qawafil API

API for logistics and shipping management. The API exposes 3 endpoints secured with apiKey authentication.

## For AI agents

Programmatically create a shipment, list shipments. Covers 3 operations with apiKey authentication.

## Scope

Does not handle payments, communications, or crm - use for e-commerce only.

## Capabilities

- Create a shipment
- List shipments
- Track a shipment
- Access Qawafil API e commerce resources via REST API

## Use cases

### E-Commerce Operations

Use the Qawafil API to perform e commerce operations programmatically. The API provides 3 endpoints covering core functionality including create a shipment, list shipments, track a shipment.

Example prompt: Call POST /shipments to create a shipment

### Automated Shipments Management

Automate shipments operations by combining multiple Qawafil API endpoints. Agents can list shipments and then track a shipment in a single workflow.

Example prompt: Call GET /shipments to list shipments, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Qawafil 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 apiKey tokens manually.

Example prompt: Search Jentic for 'create a shipment', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/shipments` | Create a shipment |
| GET | `/shipments` | List shipments |
| GET | `/tracking` | Track a shipment |

## Key resources

- **Shipments** — Operations for shipments
- **Tracking** — Operations for tracking

## Why Jentic

- **Setup:** Wiring the Qawafil API by hand means sending your key in the Authorization header and handling shipment and tracking calls yourself. Through Jentic you install once, import the Qawafil API from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** Qawafil takes shipment and tracking details in the request body and query rather than as path resources, so scope the agent to the operations it needs, such as listing shipments or checking tracking. You choose that allowed set, so creating a shipment is not included unless you add it.
- **Credential handling:** Your Qawafil key 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 'create a shipment' or 'track a shipment', and Jentic returns the matching Qawafil 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 Qawafil API use?

The Qawafil API uses an API key passed 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.

### Can I create a shipment with the Qawafil API?

Yes. Use the POST /shipments endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Qawafil 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 create a shipment through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'create a shipment'. Jentic returns the matching Qawafil API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Qawafil API have?

The Qawafil API exposes 3 endpoints covering shipments, tracking operations.

### Can I limit what my agent is allowed to do with the Qawafil API?

Yes. Because you run Jentic One yourself, your own rules decide which Qawafil operations and credentials the agent can use, so you can allow it to only list shipments and check tracking while excluding shipment creation. Qawafil takes shipment and tracking details in the request body and query rather than as path resources, so you scope access at the operation level by choosing the allowed set. Creating a shipment through POST /shipments stays off unless you explicitly add it.