API Overview
Flolive exposes set of RESTful Public APIs for external customer systems. This document contains the Flolive Public APIsfor Versions 2 and 3.
Purpose and Scope
The purpose of this document is to provide external systems with descriptive information of the interfaces that Flolive supports. These interfaces denote the full set of functionalities that the Flolive Public API exposes.
Technology
The following API technology is used universally in the Flolive Public APIs:
| Element | Technology |
|---|---|
| Integration Type | Synchronous |
| Interface Type | REST |
| Communication Protocol | HTTPS |
| Communication Format | JSON |
| Invocation Schedule | On demand |
API URL Structure
Every call to the Flolive Public API uses the same base URL pattern:
https://floportal.flolive.net/api/<version>/<command>
The placeholders in the base URL are described in this table.
| Placeholder | Description | Accepted values |
|---|---|---|
| <version> | The version of the API that you call. | v2, v3, v4 |
| <command> | The API resource or operation that you call. | customer, bulk, subscriber, auth, global, and the other resources that have their own reference topic |
Some endpoints have more path segments after the command, such as an ID or a sub-resource. The reference topic for each command shows the full structure of the URL.
NOTE: Some commands are not available in all versions. Refer to the reference topic for a command to find the versions that support it.
These examples show two calls that use the base URL pattern.
Example 1 — Session authentication (v2):
POST https://floportal.flolive.net/api/v2/auth/token
Example 2 — Retrieval of subscriber details (v3):
GET https://floportal.flolive.net/api/v3/subscriber/iccid/123456789
Each example uses the same pattern: the base URL, the version, the command, and then the parameters that the endpoint requires.
Data Security
All communication is conducted on a secure HTTPS connection. The SSL settings are defined during the integration process.
NOTE: There is no need for Network Level security.
Protocol Layer Errors
The Protocol layer errors are as follows:
| Description | Retry |
|---|---|
| I/O Errors | Yes |
| Timeout | Yes |
| HTTP Codes: | |
| 200 – OK | |
| 202 – Accepted | No |
| 400 – Bad (invalid) Request | No |
| 401 – Unauthorized | Yes |
| 403 – Forbidden | No |
| 404 – Not Found | Yes |
| 500 – Internal Server Error | Yes |
Feature Availability
This Knowledgebase documents the full range of Flolive platform capabilities. Some of the API functions described may not be available to all customers. Availability of API functions depends on customer agreements, configured permissions, and specific use cases. Certain capabilities may be enabled only for selected customers or roles, or made available as part of a controlled introduction phase.