I just want to use an API? What are plans?
A plan is collection of API resources or subsets of resources from one or more APIs. A plan can contain a mixture of operation types from different APIs. A plan can have a common rate limit for all the resources or each resource can have a different rate limit. Rate limits specify how many requests an application is allowed to make during a specified time interval.
Use this Developer Portal to browse the different plans that are available to you and select a plan that is most suitable for your requirements. Some plans have restricted access that you must request access to use. When you submit your request, the organization is notified, the API administrator assesses your request and they might contact you for more details. Other plans are available to use straight away.
How do I see my API usage?
The numbers of requests, for different APIs, that your application has made are shown on your application page.
Click 'Apps' in the main menu and then click on your application. In the 'Product Subscriptions' table you will see all plans your application is subscribed to.
For each API contained in that plan you can see the usage compared to the rate limit of the plan.
How can I test an API?
It is possible to test an API from this Developer Portal.
When looking at the details of an API you will see a list of the operations contained in the API. This will show the verb and path to use for the operation.
If you click on the operation you will see more information about it, what parameters it might take, what it returns, what possible return codes it might use and what they mean.
There is also a 'Try' button on REST APIs which enables you to try the operation out direct from the Developer Portal.
If the API requires a client ID or a client secret for identification then you can specify these using your application credentials at the top of the 'Try' section.
What is an example of a use case for one of your APIs?
The APIs enable customer servicing use cases for domains such as Service Assurance, Change Management, Service Provisioning, and the Internet of Things.

Are your APIs following any industry standards and best practices?
Bell suite of APIs is REST based and technology agnostic. Some APIs are based on the TMForum OpenAPI reference model (Click here to visit TMF site) , thus implementing industry strength design patterns to allow simple and coherent management of any given service, and enable a rapid integration.
| REST API Operations Supported | |
| GET/Resource | GET must be used to retrieve a representation of a resource or multiple resources |
| POST Resource | POST must be used to create a new resource |
| PATCH Resource | PATCH must be used to partially update a resource |
| DELETE Resource | DELETE must be used to remove a resource |
| Notification design pattern | Usage of the Publish subscribe pattern so notifications are pushed to a listener in near real-time Hub and notification event filtering |
| Asynchronous Operations design pattern | In some use cases the modification of an attribute or a creation of a record may result in the execution of a long running transaction TransactionMonitor resource is returned so that the execution of the operation can be monitored via the GET operation |

What ITSM systems do the APIs integrate with?
Our REST APIs suite is technology and vendor agnostic.
Is communication with the APIs in Push or Pull mode?
We support both Push and Pull mode communication. However, we favor the Push mode through our notification model.
Will I be given access to a Production environment or a Sandbox environment?
Some APIs only have Sandbox access. Some other APIs only have Production access. The rest will have access to both environments. Please visit the API details pages of each API for more information.
How can I register for access to the sandbox?
Once you have reviewed our API documentation and are ready to begin, follow the link below to register and gain access to the Sandbox.
How valid is the data in Sandbox environment?
The data in Sandbox environment is fake but will follow the same structure as the data in the production environment.