ISPbills
Online demo
ISPbills DocumentationOperator guides
Ctrl K
বাংলা Get support
Settings and IntegrationsOperator runbook

API Management

REST API authentication, endpoint references, webhooks, and integration guidance

2 min read
Get help
What this guide covers

REST API authentication, endpoint references, webhooks, and integration guidance

On this page

ISPbills exposes versioned JSON APIs for operator applications, automation, reporting, billing integrations, network visibility, and webhook management.

API and Webhooks

Use API v2 for new server-to-server integrations. API v1 remains available for the mobile application, iCli, and backward-compatible operator workflows.

Documentation map

The reference is split into focused pages so endpoint tables and examples stay easy to scan:

  • Authentication and fundamentals — base URL, credentials, headers, pagination, errors, and rate limits.
  • API v1 endpoint reference — every currently registered public v1 route, including customer actions, AI, analytics, logs, and payment-forwarder operations.
  • API v2 endpoint reference — all current client-credentials endpoints, request fields, scopes, and response envelopes.
  • Webhooks — endpoint registration, event names, delivery headers, signature verification, and retries.

Choose an API version

Capability API v1 API v2
Authentication Operator token and refresh token API client ID and secret exchanged for a bearer token
Intended use Existing mobile/operator tools and compatibility New backend integrations and automation
Customer operations Read, create, update, and operational actions Resource-oriented CRUD plus bills, payments, subscriptions, and usage
Webhook management Not available Full endpoint management
Rate limiting Platform API limits Configurable per API client

Base URL

All examples use the hosted application API:

https://app.ispbills.com/api

Append the version and endpoint path shown in the reference. For example, the API v2 customer collection is:

https://app.ispbills.com/api/v2/customers

Before integrating

  1. Create the appropriate credentials under Integrations → API Management.
  2. Grant only the scopes the integration needs.
  3. Keep client secrets, bearer tokens, refresh tokens, and webhook secrets on your server.
  4. Send Accept: application/json on every request.
  5. Implement explicit handling for validation errors, 401, 403, and 429 responses.

For setup details, continue to Authentication and fundamentals.

Need help applying this guide?Browse related guidance or ask the support team for help.
Browse topicGet support