Definition
RESTful API is an HTTP interface that follows the REST (Representational State Transfer) architectural style, using resource-oriented URLs, standard HTTP methods (GET, POST, PUT, DELETE), and JSON-formatted data exchange. In the International IoT Cloud Platform (ICMP), RESTful API works with Swagger/OpenAPI, API Gateway, and OAuth2 to support core functions such as card management, usage inquiry, billing, activation/suspension, and is the main method for customer systems to integrate with the platform.
Working Principle
RESTful API abstracts business capabilities as resources (such as /sims, /usage, /invoices), expressing operation intents through HTTP methods. Clients call the API through API Gateway and need to carry an API Key or OAuth2 Token for authentication. The Gateway is responsible for rate limiting, routing, and logging, forwarding requests to the backend BSS/OSS for processing. The platform usually provides Swagger documentation and SDK to lower integration barriers. Asynchronous operations (such as batch activation) can use Event Subscription or Webhook callbacks to notify results.
Use Cases
Typical scenarios include: SIM lifecycle management—activation, suspension, resumption, Decommissioning; Usage and billing—querying real-time usage, historical CDR, Usage Aggregation reports; Configuration management—PLMN Selection, Preferred Network, APN, etc.; Automated operations—customer systems automatically trigger Quota adjustments, Suspension based on usage and alarms; Integration with Reseller systems—resellers integrate APIs into their own portal to achieve automated ordering and customer management.
Practice in ICMP
SimtoLink ICMP's RESTful API covers the entire lifecycle of connection management, supporting SIM management, usage query, billing,PLMN Selection, Event Subscription Etc. The API is API Gateway Unified entry point, supporting OAuth2 And API Key authentication, with rate limiting and Audit Trail Capabilities. Provides Swagger Documentation and multilingual SDK, allowing customers to integrate quickly. Combined with TLS Encryption and Data Residency Strategies, it ensures interface security and compliance in cross-border scenarios.