Contact Us

If you still have questions or prefer to get help directly from an agent, please submit a request.
We’ll get back to you as soon as possible.

Please fill out the contact form below and we will reply as soon as possible.

  • Contact Us
  • Home
  • License Model - CPaaS Solution Answers
  • Developer Hub - Admin Guide

Open API

Written by B3Networks Academy

Updated at August 15th, 2023

Contact Us

If you still have questions or prefer to get help directly from an agent, please submit a request.
We’ll get back to you as soon as possible.

Please fill out the contact form below and we will reply as soon as possible.

  • OSS/BSS Answers
    Access Control Admin Audit B3Network Master Account Channel App Contract App Customer App Discount App Edge Server File Management Finance App Invoice App Number Management Payment Portal Settings Price List Product App Release V2 SMS Gateway Supplier App Support Center Support Hub Business Hub Sales Hub
  • App Model - Organization Management
    General Account Settings Payment and Credits Billing & Invoices Developer Tools Members & Teams Subscription Management Audit & Reports
  • App Model - Communication Apps Answers
    Bizphone BizPhone Desktop Application Bizphone Mobile Application Wallboard SIP Fax Global DNC File Explorer Virtual Line Call Recording Direct Line SMS Marketing
  • License Model - Organization Management
    General Account Settings Payment & Credits Audit & Reports Call Rules & Holidays Members & Teams Numbers Tab Billing & Invoices Organization Connect CPaaS - DNC Security Policy Security Groups Security Events Tab
  • License Model - CPaaS Solution Answers
    Phone System - Admin Guide Phone System - End-user Guide Mobile App Desktop App Web Phone Auto Attendant - Admin Guide Developer Hub - Admin Guide Microsoft Teams Operator Connect - Admin Guide Microsoft Teams Direct Routing - Admin Guide Contact Center - Supervisor Guide Contact Center - Agent Guide Omni-Channel SIP Trunk CPaaS - SIP Trunk Power SIP Trunk CPaaS Fax CPaaS Hotdesking Contact Campaign File Explorer Power Mobile App Files App
  • Telcoflow
  • Integrations Answers
    Freshdesk MS Teams - Bizphone NewRock
  • Updated Regulations
  • Ideas Portal
+ More

Table of Contents

Overview Note: API Key: Configuration Create a new API Key: Note: Delete a created API Key: Reset an API Key: Security: Configuration Add a New IP Address Delete an IP Address

Overview

The API Key section in the Open API tab allows the Developers to:

  • Grant authenticate to call B3Networks Open API.
  • Manage the created API Keys within the Organization

Note:

Click here for more information about the Open API Authentication.

 

API Key:

Configuration

Create a new API Key:

Note:

1 Project can create only 1 API Key.

  1. Go to the Developer Hub
  2. Select a Project
  3. Choose the Open API tab
  4. Click Create
  5. Copy the API key and save it in your computer
  6. Click Close and API key is created.
 

Delete a created API Key:

  1. Click on the Trash icon
  2. Confirm to Delete

Reset an API Key:

API keys are not retrievable. Anytime, a user wants to view an API key, they must reset it.

  • Click on the Reset button, right next to the Delete button
  • Confirm to reset the API key
  • Copy the new generated API key and save it.
  • Click Close and the new API key is created.

Security:

The Security section in the Open API tab allows the Developers to:

  • Allow specific IP addresses to call the Open APIs to trigger the Flows. 
  • Manage the IPs Whitelist within the Organization.

Configuration

Add a New IP Address

  • Click on the Open API tab and go to the Security section.
  • Add your IP address in “Add IP Address” field and click Enter.

Delete an IP Address

  • Click on the Trash icon 
  • Confirm to Delete
api keys project management

Was this article helpful?

Yes
No
Give feedback about this article

Related Articles

  • Checklist - Get started
  • Create a Project
  • Project Definition
  • Prerequisites & Provisioning

© B3NETWORKS PTE LTD. All Rights Reserved.

Data Policy

Service Level Agreement

Expand