API
Build on the platform. Powered by GraphQL.
The Sonar API lets you integrate and automate between Sonar's BSS and OSS platform and any third-party application.
What is GraphQL?
Ask for exactly what you need. Nothing more.
GraphQL is a query language for APIs and a runtime that executes those queries against your existing data. It gives clients a clear description of the API's data and lets them request precisely the fields they need. ISPs use the Sonar API to automate provisioning, sync billing and network data, and connect Sonar to the rest of their stack. Because it is built on GraphQL, the API can evolve over time without breaking existing clients.
Why the GraphQL API
GraphQL over REST, where it counts.
Efficient, precise data fetching
Request only the fields you need in a single call. Fewer round trips and better performance than fixed REST responses.
Strong typing and introspection
A built-in type system validates structure and catches errors. Query the schema itself to discover types, fields, and relationships.
Versioning and flexibility
Add to the schema without breaking existing clients. Clients control the exact shape of the response they get back.
No over-fetching or under-fetching
Ask for specific fields and related data in one query, so you never pull too much or make a second round trip for too little.
Resources
Everything you need to start building.
- The Sonar API
Start here. What the GraphQL API is, how it is structured, and how it supersedes the legacy v1 API.
- Consuming the Sonar API
Authenticate, send queries, page through results, and read data out of Sonar.
- Mutations in the Sonar API
Create and update records, run actions, and write data back into Sonar.
- A deeper dive into the Sonar API
Relationships, advanced querying, and patterns for larger integrations.
- API reference (live schema explorer)
Browse every query, mutation, type, and field, with the exact shape of each request and response.
- Using webhooks in Sonar
Trigger your own systems on events in Sonar instead of polling the API.
Build on Sonar
See how the Sonar API fits your build.
Talk through your integration with an ISP-only specialist, or dig into the API documentation to get going.
Book a meeting