With this update, we’ve added robust new features designed to enhance connectivity, integration, and global scalability for our partners and clients.
With the launch of Connect API v3, we are offering improved scalability and performance for our services. The Connect API v2 will remain fully operational until it reaches the end of its lifecycle, at which point a sunset plan will be communicated. However, new customers will no longer be onboarded onto v2.
Our commitment remains to continually refine and consolidate our services to ensure enhanced performance and security across our platforms. The production version of Connect API v2 will continue to be available for reference.
Explore the new possibilities with v3 and elevate your global connectivity solutions.
The Connect API v3 is available here.
]]>Previously, it was only possible to manually set activation dates for each data plan order, leading to unnecessary complexities in managing activations across various systems. This old approach lacked any real benefits for end customers, who were limited to choosing from pre-defined options or had to predict their future needs.
Effective immediately, ConnectAPI users can opt for the 'first usage activation' feature when initiating data plan orders. This means plans will activate seamlessly upon the customer's arrival at their destination and their first data usage attempt, eliminating any additional steps. Customers now have the flexibility to purchase plans in advance, free from the constraints of selecting specific timeframes or worrying about unused plan duration.
On every subscription order, the requester can set the parameter
is_first_usage_activation = trueand leave the parametersactivation_date and expiration_dateunset.
The order will be created with the status "PENDING_USAGE". This status can be used on the partners' UI to inform the customer about the purchase and pending status.
When the customer performs the first data usage at the destination, the plan status will become "ACTIVE" automatically, which can be retrieved by order details.
Use the test credentials to perform orders on the testing environment as described in the API documentation.
The existing capability works in tandem with pre-existing activation methods, if is_first_usage_activation parameter is not sent, and both activation date + expiration dates are sent, the order will be created and activated as before.
Nevertheless, we encourage our partners to move their implementation to start using the first usage activation and leverage its capabilities to sell plans before the customer travels.
The plan will be activated immediately, as expected. The same applies to regional plans.
This configuration can be provided in "expiration_date" field during order submission.
Please contact 1Global support.
]]>Starting today, Connect V1 APIs are no longer available publicly.
An archived version of the API is available here.
]]>sim_type field is now returned by the get sims details endpoint.]]>Note: This new feature is especially useful for partners using both eSIM and pSIM.
expiration_date, as an optional request parameter, in the create order endpoint to customise the subscription expiry date.duration_unit field which is returned by the product endpoints. expiration_date cannot be longer than the duration of the selected plan and that making it shorter will not change any other plan settings, such as price or data allowance.product-id query parameter was renamed to product_id. ]]>Note: You can only delete a SIM and cancel an order if the SIM has never been installed.
qrcode_url field is now returned by the get orders details endpoint for all completed activation orders ("NEW _ESIM").lpa_url field is now returned by the get SIM profile details endpoint.lpa_url field is now returned by the get order details endpoint for all completed activation orders ("NEW _ESIM").dataValue and dataUnit parameters have been removed from the request body as they are not applicable to current use-cases.id parameter is now also returned by the Create order endpoint. This new field replaces the existing externalId which is being deprecated.]]>Note: Please migrate to new
idparameter since theexternalIdis being deprecated. TheexternalIdfield will be removed in a future release.
USAGE_THRESHOLD and SUBSCRIPTION_END.product_id parameter is now accepted instead of the deprecated allowanceId (on the Create order endpoint)]]>Note: Since the Product IDs have changed, you must ensure that the product catalogue is not cached, or if so, the catalogue is refreshed frequently.