Reference

API documentation

All endpoints are served over HTTPS with JSON payloads. Base URL for production requests: https://api.convergefabric.com/v1

Authentication

Authenticate every request using a bearer token. Generate tokens within the admin portal or via the create token endpoint.

GET /v1/accounts/current
Authorization: Bearer <token>

Tokens can be scoped to orders:write, orders:read, metrics:read, or admin. Calls made without sufficient scope return a 403 insufficient_scope response.

Orders API

Create, update, and list service orders. Orders transition through draft, provisioning, active, and closed states.

Create order

POST /v1/orders
{
  "company_id": "c_7f21ff",
  "service": "data-centre-interconnect",
  "capacity_mbps": 1000,
  "region": "sin-1",
  "metadata": {"campaign": "apac-expansion"}
}

Field	Type	Description
company_id	string	Identifier of the company this order belongs to.
service	string	One of `carrier-backhaul`, `data-centre-interconnect`, `edge-onramp`.
capacity_mbps	integer	Requested capacity in Mbps.
region	string	Region slug referencing available PoPs.

Webhooks

Subscribe to lifecycle events to receive real-time updates. Each webhook request contains an X-CF-Signature header for HMAC verification.

POST https://example.com/webhooks/orders
{
  "event": "order.provisioned",
  "order_id": "ord_f9ddab",
  "timestamp": 1689782519,
  "payload": {...}
}

Error handling

Errors follow a consistent format:

{
  "error": "invalid_request",
  "message": "Region is required",
  "request_id": "req_82bd4b"
}

Reference request_id when contacting support for faster troubleshooting.