Developer

Empower Your IoT Applications with Com4 API Features

Our IoT API is engineered to provide comprehensive control and flexibility, allowing you to tailor IoT connectivity to your precise business needs. Discover the powerful features designed to streamline your operations:
 

Sim 1

Comprehensive SIM Lifecycle Automation

Take programmatic control over the entire lifecycle of your SIM cards. From initial activation and provisioning to suspension, reactivation, and eventual deactivation, you can automate these crucial processes, reducing manual intervention and speeding up deployment.

Monitoring

Real-Time Connectivity Monitoring

Gain instant, granular insights into the status and data consumption of your IoT devices. Our API allows you to fetch real-time data usage per SIM or across your entire account, enabling proactive management and cost control.

Maintenance

Streamlined Device Provisioning

Simplify and accelerate the onboarding of new IoT devices. Automate the registration and configuration process, ensuring your devices are connected and operational with minimal delay.

Data Package

Seamless System Integration

Built on RESTful principles, the Com4 API is designed for easy integration. Embed IoT connectivity management directly into your existing enterprise software, custom dashboards, and operational workflows, creating a unified management experience.

Laptop-lock

Secure & Reliable Access

Security is at the core of our API. Utilizing the robust OIDC (OpenID Connect) client credentials flow, we ensure that all communications with the API are authenticated and secure, protecting your valuable data and device integrity

Sim

Granular Roaming Controll

Effortlessly manage and optimize roaming profiles for your devices deployed globally. The API provides the tools to configure roaming settings, ensuring cost-effective and reliable connectivity wherever your devices operate.

Control

Customizable Service Profiles

Tailor connectivity services to the specific needs of different device types and use cases. Assign and manage service profiles programmatically to optimize performance and cost.

Scalable

Scalable Architecture

Whether you're managing hundreds or millions of devices, the Com4 API is built to scale. Our architecture is designed to handle a large volume of requests and support your growing IoT fleet.

Code

Developer Centric Design

We prioritize the developer experience. With clear, well-documented endpoints and adherence to standard protocols, integrating with the Com4 API is straightforward, allowing your development teams to get up and running quickly.

API code zoomed in on a laptop in a dark room with small focus depth.

 

 

Core API Endpoints for Your IoT Solutions

The Com4 IoT API offers a rich set of endpoints to manage every aspect of your IoT connectivity. Below are some of the core functionalities you can access. For complete details, please refer to our full API documentation.
(Developer Note: The following are example endpoint structures. Always consult the official Com4 API documentation for the most current and complete endpoint definitions, request/response formats, and parameters.)

Account Management

GET /accounts: Retrieve a list of accounts accessible to you.
GET /accounts/{accountId}: Fetch detailed information for a specific account.
GET /accounts/{accountId}/roaming-profiles: Access and manage roaming profiles associated with a particular account.

SIM Card Lifecycle & Management

GET /sim-cards: List all SIM cards within your account or a specified scope.
GET /sim-cards/{simId}: Retrieve comprehensive information about a specific SIM card using its unique identifier.
POST /sim-cards/register: Register new SIM cards to your account.
PATCH /sim-cards/{simId}: Update various attributes of an existing SIM card.
PUT /sim-cards/{simId}/activate: Programmatically activate a SIM card.
PUT /sim-cards/{simId}/suspend: Temporarily suspend a SIM card's subscription and network access.
DELETE /sim-cards/{simId}/unsuspend: Reactivate a previously suspended SIM card.
DELETE /sim-cards/{simId}: Deactivate or cancel a SIM card's service.

Data Usage & Monitoring

GET /sim-cards/data-usage: Get an overview of data usage aggregated across multiple SIM cards.
GET /sim-cards/{simId}/data-usage: Retrieve specific, detailed data usage information for an individual SIM card.
GET /sim-cards/{simId}/data-sessions: Access historical data session records for a particular SIM card.

Service & Profile Configuration

GET /sim-cards/{simId}/product: View the current product or service plan associated with a SIM card.
PUT /sim-cards/{simId}/product: Assign or change the product or service plan for a SIM card.
GET /sim-cards/{simId}/service-profile: Retrieve the assigned service profile for a SIM card.
PUT /sim-cards/{simId}/service-profile: Set or update the service profile, tailoring services like data limits or network access.
PUT /sim-cards/{simId}/private-apn: Configure a private Access Point Name (APN) for a SIM card for enhanced security.
GET /sim-cards/{simId}/private-apn: Check the currently active private APN profile on a SIM card.

Authentication & Authorization

The Com4 API utilizes the OIDC (OpenID Connect) client credentials flow for secure, server-to-server authentication. You will typically use a client_id and client_secret to obtain an access token from our authorization server (e.g., PUT /v1/clients-registrations/openid-connect/{client_id}), which is then used to authenticate your API requests.

 

Getting Started with the Com4 IoT API 

Integrating Com4's powerful connectivity solutions into your applications is straightforward:
 

1. Request Access: Contact our support team (e.g., [email protected] or your account manager) to obtain your API credentials (client_id and client_secret).

2. Consult the Documentation: Dive into our comprehensive API documentation for detailed endpoint descriptions, request/response examples, and best practices.


3.Develop & Integrate: Utilize your preferred programming language to make HTTP requests to our API endpoints. Leverage our robust features to automate and manage your IoT deployments.


4. Test & Deploy: Thoroughly test your integration in a development environment before deploying to production.
 

View Full API Documentation

Earth half small

 

Your Questions About the Com4 IoT API

Here are some common questions developers and businesses have about leveraging the Com4 IoT API:

What functionalities does the Com4 IoT API offer?

API provides a wide range of functionalities, primarily focused on SIM lifecycle management (activation, suspension, deactivation), real-time data usage monitoring, device provisioning, account management, service profile configuration, and private APN setup. It allows you to automate many of the manual tasks associated with managing a large fleet of IoT devices.

How can I start using the Com4 API? What are the steps for access?

To get started, you'll typically need to contact Com4 support (e.g., via [email protected]) or your dedicated account manager. They will guide you through the process of obtaining the necessary API credentials (client ID and client secret) required for authentication.

What authentication mechanism does the Com4 API use?

Our API employs the secure and industry-standard OIDC (OpenID Connect) client credentials flow. This involves your application using a client ID and client secret to request an access token from our authorization server, which then authorizes your subsequent API calls.

Where can I find detailed documentation for all Com4 API endpoints?

Comprehensive documentation, including detailed endpoint descriptions, request and response formats, parameter definitions, and code examples, is available on the Com4 developer portal or can be provided by our support team. (Ideally, this would be a direct link).

Which programming languages are compatible with the Com4 REST API?

Being a RESTful API, the Com4 IoT API can be integrated using virtually any programming language that can make standard HTTP requests. This includes popular languages like Python, Java, C#, Node.js (JavaScript), Ruby, PHP, Go, and many others.

How does the Com4 API help in scaling large IoT deployments?

The API is crucial for scalability by enabling automation. You can programmatically manage thousands or millions of SIMs and devices, automate provisioning processes, monitor usage patterns in bulk, and integrate these controls into your own scalable management systems, significantly reducing manual effort and operational overhead.

Can I perform bulk operations on SIM cards using the API?

Yes, many API endpoints are designed to support bulk operations or can be iterated through efficiently for managing large numbers of SIM cards simultaneously, such as bulk activation or status updates. Refer to the specific endpoint documentation for details on batch processing capabilities.

Does the API provide real-time notifications or webhooks for events?

While direct webhook information isn't detailed here, many advanced IoT platforms offer event-driven notifications. Please consult the full API documentation or contact our support to inquire about webhook capabilities for events like data limit thresholds or SIM status changes.

What are the API rate limits I should be aware of?

To ensure fair usage and stability for all users, our API may have rate limits. Specific information on rate limits (requests per second/minute) can be found in the official API documentation or by contacting our support team.

How is API versioning handled by Com4?

API versioning is managed to ensure backward compatibility where possible and clear pathways for upgrading to new versions. Details on the current version and any versioning strategy will be outlined in the API documentation.

Speak to an
expert

Unlock the path to a brighter future with our unparalleled IoT solutions and support. Partner with us today and pave your highway to success.