Mobius API Docs: REST API, Requests & Responses

The API Docs page provides technical documentation for applications that need to communicate with the platform programmatically. It describes the available API requests, endpoints, required parameters, and responses.

API Basics

Before using the API Docs page, it helps to understand several key terms.

API

API stands for Application Programming Interface. It allows two software programs to exchange information. One program sends a request, and another program returns a response.

REST

REST is a common set of rules for exchanging information over the internet. Each action has its own address, called an endpoint.

Instead of visiting an endpoint in a browser, a program uses it to request data or perform an action in the platform.

JSON

JSON is the format used to represent the information exchanged through the API. It is structured text made up of labels and values.

For example:

Request and Response

A request is sent by a program to ask for information or perform an action.

For example:

A response is the information returned by the platform. It can contain data in JSON format or a confirmation that an action was completed.

Each entry on the API Docs page represents a possible request and describes the response returned by the platform.

Swagger

The API Docs page is generated using Swagger. Swagger reads the technical description of the available API requests and generates an interactive documentation page.

This keeps the documentation aligned with the requests supported by the platform.

API Docs Page

At the top of the page, the documentation identifies the set of available API instructions and provides a base address used by the requests.

The requests are grouped by subject. For example:

• Audit logs
• Authentication
• Statistics

Each entry includes:

• Endpoint address
• Description
• Required request information
• Response information

When an entry is opened, the exact request parameters and response structure are displayed.

API Request Example

For example, another application can use the /auditlog/count endpoint to check the number of audit log entries.

The application sends a JSON request to the endpoint. The platform processes the request and returns a JSON response.

For example:

The exchange can be represented as:

Application → /auditlog/count → Mobius → JSON response

No user interaction is required. One program sends a request, and the platform returns the corresponding response.

API Documentation by Product Area

The API Docs page is available for different product areas.

API documentation can cover:

• Audit logs
• Authentication
• Statistics
• SS7
• SIP
• SMPP

Each API Docs page documents the requests available for its specific part of the system.

The API Docs page described here contains general, platform-wide commands.