Universal API Core V1.7 integration guide manual

Updated 1 month ago 38 views

# Phone System Global (PSG) Universal API Core V1.7

## Multi-Tenant Programmatic Integration Interface for Reseller Partners

Welcome to the Phone System Global (PSG) wholesale automated interface node. This environment provides structured RESTful endpoints designed explicitly for Reseller Partners to bridge storefront websites, billing platforms, or mobile apps directly into our single-point proxy provisioning network.

All upstream operations execute through a securely hidden, proxied architecture that ensures absolute network stability. Your unique 32-character Developer Key allows you to programmatically manage global data eSIM lifecycles, verify stock availability, deploy predefined network templates, and process real-time top-ups.

---

### ? 1. Authentication Handshake

Every programmatic API network request to our infrastructure core must contain your private token authorization header. 

* **Production Entry Node Base URL:** `https://mybilling.phonesystemglobal.com`

* **HTTP Header Configurations:**

  ```http

  Authorization: Bearer [YOUR_32_CHARACTER_LOWERCASE_PSG_KEY]

  Content-Type: application/json

  Accept: application/json

  ```

---

### ? 2. Core API Integration Endpoints Workflow (Based on Telna MVP V1.7)

#### Workflow Step A: Verify Selected eSIM Availability

Before assigning a plan or generating profile elements for an end-user customer checkout, query our proxy mapping tables to confirm the physical profile state is in stock and ready for distribution (`PRE_SERVICE`).

* **Endpoint Sub-Route:** `https://mybilling.phonesystemglobal.com/comverify-sim`

* **HTTP Method:** `GET`

* **Query Parameters:** `?iccid={iccid_string}`

* **Expected Successful Response (JSON):**

  ```json

  {

     "status": "success",

     "iccid": "8987700000012345671",

     "inventory_state": "PRE_SERVICE",

     "message": "eSIM profile is active and available for retail customer assignment."

  }

  ```

#### Workflow Step B: Provision & Assign Predefined Data Package Template

To bind a high-speed roaming data plan profile to an active user device, instantiate a secure `POST` call. All plans deploy using the `AUTO` activation rule, meaning they initialize automatically the moment the user hooks into a cellular tower network.

* **Endpoint Sub-Route:** `https://mybilling.phonesystemglobal.com/comprovision-package`

* **HTTP Method:** `POST`

* **Payload Request Body Parameters Structure (JSON):**

  ```json

  {

     "order_reference": "PSG-RESELLER-ORD-10029X",

     "target_iccid": "8987700000012345671",

     "package_parameters": {

         "supported_countries": ["CAN", "USA", "ZAF", "GBR"],

         "data_usage_allowance_bytes": 10485760,

         "voice_usage_allowance_minutes": 0,

         "sms_usage_allowance_count": 0,

         "activation_type": "AUTO",

         "validity_duration_seconds": 2592000

      }

  }

  ```

* **Expected Core Output Response & Activation QR Handshake (JSON):**

  ```json

  {

     "status": "success",

     "transaction_id": "PSG-TXN-99238101",

     "package_id": "PKG-772810-A",

     "activation_profiles": {

         "smdp_address": "://telna.com",

         "lpa_activation_string": "LPA:1$://telna.com$PSG-PROXIED-TOKEN-DATA-XYZ",

         "qr_code_rendering_url": "https://mybilling.phonesystemglobal.com/assets/qr/render?data=LPA:1$://telna.com$PSG-PROXIED-TOKEN-DATA-XYZ"

      },

     "wallet_ledger": {

         "currency": "USD",

         "debited_amount": 0.00,

         "remaining_prepaid_balance": 1000.00

      }

  }

  ```

  *Developer Directive: Take the returned `lpa_activation_string` or the `qr_code_rendering_url` and map it dynamically onto your web store's success screen and automated confirmation emails so end-users can scan it instantly to enable data.*

#### Workflow Step C: Check Data Usage & Remaining Balances

Query this endpoint periodically to display remaining data usage metrics to users inside your mobile app or storefront account view.

* **Endpoint Sub-Route:** `https://mybilling.phonesystemglobal.com/comcheck-usage`

* **HTTP Method:** `GET`

* **Query Parameters:** `?package_id=PKG-772810-A`

* **Expected Response (JSON):**

  ```json

  {

     "package_id": "PKG-772810-A",

     "data_bytes_allocated": 10485760,

     "data_bytes_remaining": 8388608,

     "package_status": "IN_SERVICE"

  }

  ```

#### Workflow Step D: Top-Up Existing User eSIM with a Dollar Value (Optional)

If a retail user consumes their core plan bytes early but desires to continue network roaming data routing on a pay-as-you-go balance tier, use this endpoint patch loop to add a cash value directly onto their SIM wallet:

* **Endpoint Sub-Route:** `https://mybilling.phonesystemglobal.com/comtopup-wallet`

* **HTTP Method:** `PATCH`

* **Payload Request Body (JSON):**

  ```json

  {

     "target_iccid": "8987700000012345671",

     "wallet_mode": "SIM",

     "topup_amount_usd": 25.00

  }

  ```

---

### ? 3. Technical Network Operations Support Desk

For automated API rate-limiting adjustments, custom multi-IMSI footprint configurations, or system logs inspection, open an authenticated support ticket inside your billing control center workspace panel layout to establish a direct secure routing thread with our Network Operations Center (NOC).

Still need help?

If this article did not answer your question, our support team can help.

Contact support
Top