Retrieve additional data using PortaBilling API

When an external application receives a provisioning event, it connects to PortaBilling via the API to retrieve additional information about the modified entity and monitor provisioning statuses.

First, the application should call the session/login method of the PortaBilling API. The login request must contain a pair: a user login and password or a user login and API token (specified on the admin web interface).

Example

POST /rest/Session/login HTTP/1.1
Host: demo.portaone.com
Content-Type: application/json
Content-Length: 57 {
"params": {
"login": "demo",
"password": "exAmple"
}
}

In response to the session/login method, the API user (an external application) receives the following fields: "access_token", "expires_at", "refresh_token", and "session_id".

Example

{
"session_id": "fb48b180539529497f3475c71e0bdc66",
"refresh_token": "836466a06bef49c38305afc14e13e487",
"expires_at": "2022-08-28 13:07:30",
"access_token": "eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE2NjE2OTIwNTAsImlfdXNlciI6NDQwLCJpX2VudiI6NDEsImxvZ2luIjoiZGVtbyIsInNjb3BlcyI6ImVzcGYuYXBpOndyaXRlIGVzcGYuaGFuZGxlcnM6d3JpdGUiLCJpYXQiOjE2NjE1MTkyNTAsImp0aSI6ImZiNDhiMTgwNTM5NTI5NDk3ZjM0NzVjNzFlMGJkYzY2IiwicmVhbG0iOiJhZG1pbiIsImF1ZCI6WyJwb3J0YWJpbGxpbmctYXBpIiwicG9ydGFzaXAtYXBpIiwiZXNwZi1hcGkiXSwiaXNfc3VwZXJfdXNlciI6MH0.Qou3zbdFvF5bGup0tGrAvPAjoaeoeTMZQN3awMVOJAIKZGSLWL7kmhm3Xzjr05xZPQp3vrwtv4y4SygnXkzrcbYiIzzV-dcrANhRbOTnTPUMMU_t2rgNCG9Qo2eVzUv-4u_g1mVuBqx_8pIZs93g7C8-6O7XP_hg9Oo0BilB4W0jp0zjTxdp46sQ2aP2q7HZNLO6USL5vchxPGWPQp2VPL9cW4RRO71Ok2a4eGRir60ytvUz98fAlHtf-AUDFd3BkEltRN4BYyGGuWCeihengU0Z8DBucCmcQdAeUBbzo65D6V5ubSWOwUNvnjfHmmsqfS50G_7-GMKYaBqMfBRPmw"
}

We recommend performing authorization using an access token in the requests to the ESPF API.

For a detailed description of request and response parameters, refer to the PortaBilling API documentation.

Refer to the PortaBilling API for a more detailed description of API methods and their structures.

Here is the list of the most commonly used API methods that will help you receive the necessary information from PortaBilling:

• Account/get_account_info – use this method to receive subscriber information, such as account ID (e.g., DID, MSISDN, IPv4 address, login), service password, the unique ID of the product (e.g., i_product) and name, activation and expiration dates, available funds, status (e.g., active/blocked/terminated), service policy (e.g., the unique ID of the access policy) and service features that are enabled for this subscriber, etcc.
• Account/get_custom_fields_values – use this method to receive custom information assigned to an account (e.g., db_value).
• Account/get_service_features_list – use this method to retrieve the list of service features that are available for an account.
• Product/get_product_info – use this method to receive product information such as unique IDs of included services (e.g., i_service), subscription (i_subscription) and volume discount plan (e.g., i_vd_plan), etc.
• Service/get_service_info – use this method to receive service details such as service name, rating base, etc.
• SIMCard/get_card_list – use this method to receive SIM card details such as MSISDN, IMSI and the unique ID of the SIM card (i_sim_card), etc.
• AccessPolicy/get_access_policy_info – use this method to receive Internet access policy details such as the unique ID of a service policy (i_service_policy), hotlining parameters, etc.
• ServicePolicy/get_service_policy_info – use this method to receive service policy details such as specific service attributes.
• DID/get_number_info – use this method to receive DID details such as cost and revenue, owner, batch, etc.
• Invoice/get_invoice_info – use this method to receive invoice details such as the status of the invoice (e.g., paid/partially paid/unpaid), the amount already paid by the customer, the amount that must be paid by the customer and the date when the invoice was generated, etc.
• Customer/get_customer_info – use this method to receive customer record details such as balance, billing status (e.g., active/blocked/suspended), billing period, personal information (e.g., salutation, name, address, etc.), cloud PBX configuration, etc.

Refer to the PortaBilling API guide for a more detailed description of API methods and their structures.