Developer portal

Integrate with the platform your customers already run on.

Ridge Arc Network is the quoting, sales and installation platform for home comfort systems. Partners connect three ways: push leads and appointments in, pull installation jobs out, and receive signed webhooks the moment anything changes.

POST/api/inbound/leadsx-api-key: ran_test_…
{
  "fullName": "Dana Whitfield",
  "email": "[email protected]",
  "phone": "+1 269 555 0142",
  "address": "1685 Brookmoor Ln, Portage, MI 49024",
  "smsConsent": true
}
→ 201 Created  { "status": "created", "leadId": "lead_…" }
when the rep sends the quote
EVENTquote.sentx-ridge-arc-signature: v1=…
{
  "id": "evt_01J…",
  "event": "quote.sent",
  "apiVersion": "2026-08-26",
  "occurredAt": "2026-09-14T15:02:41Z",
  "resource": { "type": "proposal", "id": "prop_…", "version": 3 },
  "data": { … }   // event-specific payload, see the catalogue
}

Inbound API

Send leads and book appointments from your CRM, website, call centre or lead marketplace. Duplicates merge by address, so re-sending is safe.

POST /inbound/leads →

Installer API v1

Installation companies pull assigned jobs, post status events, set schedules and assign technicians, with optimistic versioning and idempotent writes.

GET /partner/v1/jobs →

Webhooks

HMAC-signed deliveries for quotes, projects, appointments, deposits, invoices, rebates and installation jobs. Two-phase secret rotation, replay window, dead-letter visibility.

Verify a signature →

From first call to production key

How onboarding works

  1. Intake

    Your company fills in the partner intake form: legal entity, partner type, brand assets, the people who need logins and the systems you want connected. We use it to set up your company on the platform exactly once, correctly.

  2. Sandbox

    A developer signs in with a work email, requests a sandbox key for the API they need, and builds against synthetic data on the sandbox host. Sandbox keys carry the ran_test_ prefix and never touch real customers.

  3. Certification

    Before production keys are issued we check the short certification list: signature verification, idempotency, retry handling, secret storage, and the data boundary for your partner type. Submit it from the checklist form.

  4. Production

    Production keys (ran_live_) are minted by the platform owner inside the platform's console, shown once, and rotated on a schedule you agree with us. Revocation is immediate.

Access depends on your partner type

Legal regulations, customer privacy and security controls limit which features and fields each partner can reach. Installers see the job, not the price. Lead sources see acknowledgements, not the customer's file. The rules are written down, not implied.

Read access & compliance →

What you can rely on

  • Dated API version (2026-08-26) returned on every Installer API response; breaking changes ship as a new date with at least 90 days of overlap.
  • Every key request, rotation, revocation and webhook subscription change is written to a tamper-evident audit log.
  • Rate limits are published per surface and returned in headers, never guessed.
  • An OpenAPI document and a Postman collection for the partner surfaces, kept in step with this site's changelog.
Who integrates, and with what

Every partner type has a written boundary

Partner typeTypical systemPrimary surfaceSees customer contact details?Sees pricing?
Lead source / marketplaceCRM, web forms, call centreInbound API: leadsSends them; receives only an acknowledgementNo
Booking / scheduling vendorCalendar, dispatch boardInbound API: appointments, webhooksName and address for the booked visitNo
Installer companyField service softwareInstaller API v1, install webhooksName, address, phone for assigned jobs onlyNo
Distributor / supplierERP, punch-out catalogueCatalogue feed (by arrangement), webhooksNoTheir own cost lines only
Financing / incentive programApplication portalWebhooks (deposit, rebate), redirect linksOnly what the customer submits to them directlyFinanced amount only
Accounting / bookkeepingLedger, payrollFinancial journal webhooks, exportsNoYes, journal level
Licensee (runs the platform under its own brand)Everything aboveFull console plus every API for its own companyIts own customersIts own books

Details and the legal reasoning for each row are on Partner types & scope.