Business Engine Partner API
COS Systems provides a two-way API that allows service providers to both retrieve and create information within the system.
Technical Overview
The API is built on REST principles and communicates via JSON. It is optimized for use in automated workflows such as service provisioning, billing integration, and network analysis.
Functionality
Customer
The API allows you to search for and list customers in the system. This is useful for retrieving information about existing customers and their associated services or network objects.
Customer Invoices
You can search for or list invoices, retrieve details of a specific invoice, and register an external payment. These features support efficient billing and payment processing directly through the API.
Objects
The API provides functionality to list and search for network objects, retrieve information by object ID or IP address, and check availability. You can also access technical and operational details related to a network contract, and even reboot network equipment connected to a specific object.
Orders
Order management is a major part of the API. You can create, update, and cancel orders, as well as manage metadata, provisioning, and desired activation dates. Orders can be paused, resumed, rejected, or canceled immediately. You can also retrieve a full history of any given order and abort a cancellation if needed.
Prospects
You can list or search for sales prospects, retrieve specific prospect data, create new ones, or discard those that are no longer relevant. This is especially useful for managing leads and potential customer interest.
Services
Retrieve a list of all published services or check which services and service types are available for a specific object. This is helpful for product offering, provisioning, or availability checks.
Tickets
The API supports full ticket management: list, create, update, close, reopen, and assign tickets to either the service provider or operator. You can also add notes to tickets and fetch available ticket categories and resolution codes to streamline support workflows.