Documentation Index
Fetch the complete documentation index at: https://docs.ugift.me/llms.txt
Use this file to discover all available pages before exploring further.
UGiftMe REST API
Server-side integration over/api/v1/business: catalog, orders, wallet, and outbound webhooks using X-API-Key.
Base URLs
| Environment | Base URL |
|---|---|
| Sandbox | https://api-stage.ugift.me |
| Production | https://api.ugift.me |
/api/v1/business (for example GET /api/v1/business/auth).
Authentication
Every documented request requires:X-API-Key: <your-api-key>
Keys are UUIDs issued from the dashboard. If your key has an IP allow list, requests must come from an allowed address.
Use GET /api/v1/business/auth to validate a key and retrieve minimal integration metadata (health checks and connection tests).
What you can call
| Area | Role |
|---|---|
| Products | List, filter, and search the catalog available to your key. |
| Orders | Create single or bulk orders; list, search, and fetch by id; poll async order requests. |
| Wallet | Wallets, balances, and transaction history. |
| Webhooks | Register HTTPS endpoints for outbound events (order lifecycle, payments, catalog, wallet). |
Orders (async)
When async processing is enabled,POST /api/v1/business/orders may return 202 with orderRequestId and status: queued. Poll GET /api/v1/business/orders/order-requests/{id}. Optional Idempotency-Key is supported on create and bulk create.
Webhook events
Register underPOST /api/v1/business/webhooks. Allowed events include: order.queued, order.processing, order.succeeded, order.failed, payment.succeeded, payment.failed, product.updated, wallet.updated.