Step-by-step

Start building in three simple steps

This guide walks through creating API keys, making your first authenticated request, and subscribing to webhooks.

1. Request access

Login to the Converge Fabric admin portal and request API access under Developer Tools → API tokens. Each token is scoped to your company.

2. Install SDK

Install our TypeScript SDK: npm install @convergefabric/api. Or use direct HTTPS calls with your favourite HTTP client.

3. Listen to webhooks

Configure webhook endpoints to receive provisioning, status, and billing events for real-time automations.

Environment URLs

Environment	Base URL
Production	`https://api.convergefabric.com/v1`
Sandbox	`https://sandbox.api.convergefabric.com/v1`

Sandbox and production share the same authentication model; tokens are isolated per environment.

Prerequisites

Converge Fabric company account
Administrator approval for API access
HTTPS endpoint for webhook reception

Sample Node.js script

import { Converge } from '@convergefabric/api';

const client = new Converge({ token: process.env.CF_TOKEN });

const order = await client.orders.create({
  companyId: 'c_7f21ff',
  service: 'carrier-backhaul',
  capacityMbps: 500,
  region: 'lhr-1'
});

console.log('Order ID', order.id);