ASTPP API Guidelines

By Samir Doshi
2 min

Enterprise Only
This documentation applies only to ASTPP Enterprise Edition.
If you're using the Community Edition, please contact us for upgrade options or API access.

1. Introduction

The ASTPP API allows you to integrate, extend, and automate functionalities of the ASTPP VoIP billing platform using programmatic access. It enables operations such as account management, call data retrieval, billing automation, and more. This document provides the necessary steps to install, configure, and begin using ASTPP APIs securely and efficiently.

These APIs are designed for technical users - either customers with in-house developers or third-party technical teams.

2. How to Install API Add-on

To access the ASTPP APIs, you must first install the API Add-on.

📦 Steps:

  1. Log in to your ASTPP Admin Panel.

  2. Go to Get Addons → Enterprise

  3. Locate the add-on named "Application Programming Interface Add-on"

  4. Click Install.

After successful installation, the API endpoints will be accessible via HTTP/HTTPS from your ASTPP instance.

3. How to Configure API Access

🔐 Step 1: Generate Authentication Token

API access is protected by a token-based system. Tokens are generated and shared by the system administrator manually.

Note: Users cannot generate tokens via the API or UI.

Go to:

vim /var/lib/astpp/astpp-config.conf

Change and copy api_auth_key value. This api_auth_key will be used as x-auth-token in api request.

astpp-config.conf file

The token will be used in every API request for authentication.

📋 Required Headers

When making API requests, the following headers must be included:

Header

Example Value

Description

Header

Example Value

Description

x-auth-token

qc8fVMjsKTK7qU6n4jSNWEQvIZnEH3Gf

Your authentication token. Copied value of api_auth_key.

Content-Type

application/json

Format for request payloads

🌐 Base URL Configuration

You must define the base API URL in your environment. Typically it follows the format:

https://<your-astpp-domain>:<port>/

Example:

https://demo.astppbilling.org/

4. Using Postman for ASTPP APIs

We provide a comprehensive Postman Collection that contains all available ASTPP API endpoints, grouped logically for easy access and testing.

📌 How to Set Up Postman Environment:

  1. Open Postman and click the Environment quick look icon (⚙️) at the top right.

  2. Select Add or Edit to configure the environment.

  3. Add the following variables:

Variable Name

Example Value

Description

Variable Name

Example Value

Description

api_url

https://yourdomain.com:8091/

Replace with your ASTPP domain

x-auth-token

your_token_here

Token provided by your admin

  1. Name the environment (e.g., ASTPP Live).

  2. Select the environment from the dropdown to activate it before testing.

Once this is configured, you can start making requests directly using the shared collection.

5. Additional Notes

  • All APIs are hosted on self-hosted ASTPP instances.

  • Ensure your firewall or server security group allows access to the port configured for API access.

6. Postman Collection Link

👉 Access the full API documentation and endpoints here:
🔗 ASTPP Postman API Collection

7. Support

For questions, issues, or custom API development:

Related content