I have never used an API before. Is there a guide to understand what should I do to start?
Yes, the Developer Portal provides an API Quick Start Guide available here.
How can I check if I have access to an API?
Most of the APIs are available to all Enterprises; some of the APIs are subject to further Operator´s authorization; some of the APIs are only available to Operators. You can check to which API you have access granted looking in the service portal, under Personal Settings->User details->Permissions.
How can I simply validate from my PC that an API is working correctly?
For the REST APIs you can use the swagger pages available here.
For the SOAP APIs you can use Postman with the collection that could be found in the dedicated section of the site.
Why do I need token every time I call an API?
The token is needed for security reasons, and it has an expiration time. The token refresh will also force the application to re-authenticate periodically, to avoid security breaches in the system. It is a very good practice to renew the token instead of re-logging, as the resources consumption on Client and Server side is very much reduced.
After logging in on the API I see the expirationTime is 1800000. Is this in milliseconds meaning the session token is valid for 30 minutes?
Yes, the expiration Time of the Token is expressed in milliseconds.
What APIs would my support center need in order to support our products in operation, or to support the LCM of my products?
The API documentation pages summarize the role of each API. Which API to be used, is very much dependent on the business logic and the business process which applies, there is no generic answer. The Tutorials page and the Application Development pages of the Developer Portal provides good examples on different API usages in answer to different application needs.
Where is the documentation for all the APIs?
The Developer Portal provides an hands-on access to all IoT Accelerator APIs here.
For more detailed information on each API you can read the API specification documents provided by your Connectivity Provider in the service portal. If these information are not available, you can ask your Connectivity Service Provider to make these available for you on the service portal.
What is the base URI to access the APIs? Which are the credentials to be used in the API calls?
The base URI is the same as the link to the portal, and it will be provided to you by your Connectivity Service Provider together with the credentials to access them. The credentials (username and password) that you will receive will be used to access the service portal and to obtain the tokens for the APIs usage.
How to get notified for a new subscription (operation = CREATE_SUBSCRIPTION) containing imsi, msisdn, iccid and status?
Currently IoT Accelerator doesn’t send notification for a new subscription. When new subscriptions are created (means SIM order is completed and is provisioned, usually after an order is placed manually and contains bulk SIM cards) then you will get the order file containing imsi, msisdn, iccid. When the order is placed via service portal, the subscription status is selected as ACTIVE, which means the SIM is ready be to be used. Once it’s completed, you can get the subscription details using subscription management API.
Apart from API calls, can I also receive spontaneous notifications from the IoT Accelerator?
Yes, several kinds of notifications exist. You can find most of them in the tutorial section of the Developer Portal:
Regarding the subscription management API, what happens when an order is placed by using the “POST /subscriptions/order” API? What is the purpose of generating an order file on FTP? Who is supposed to access that file?
The order file is fetched by the operator, who transfer it to their SIM provider. The file contains the details which the SIM provider needs to produce SIMs. When produced, the SIM provider sends back another file with details that IoT Accelerator uses to provision the SIMs in the system. Normally the operator delegates the file fetching to the SIM provider.
Where can I find the service portal user´s guide?
The portal user´s guide can be downloaded from the service portal, under Support->Documentation->Document Library. If the user guide is not available, or you need it in a different language, you can ask your Connectivity Service Provider to make that available for you on the service portal.
In the Developer Portal I have found several documents and test reports describing the eUICC localizations. Is there a possibility for me to try and test eUICC localization services?
The eUICC localization service is available to some of the Connectivity Service Providers which are offering IoT Accelerator services. Please get in touch with your Connectivity Service Provider to know more on the availability of this service in your market.
Where can I find information regarding data and SMS traffic consumption?
SMS and Data Consumption information are available through APIs and Service Portal. Please browse the Learn section of the Developer Portal to know which API to use and which section of the Service Portal provides this information.
Where can I find useful information to understand the connectivity and network traffic patterns of my devices?
The quickest option is to have a quick look at the connectivity and traffic patterns is the Service Portal. A specific Tutorial is available for that, here. APIs are also available to query the network information, here.
Can I setup alerts for specific triggers conditions happening in the Platform (e.g. traffic data over a certain quota, devices status change, etc.)?
Yes, several Triggering conditions could be set and different alerts type or notification can be issued. Here is a complete use guide on how to setup the triggering conditions.
Are Triggers generating additional data traffic to/from devices?
No, the Triggers are managed centrally by the IoT Accelerator. No additional Data Traffic is generated as a result of Trigger execution.
Do you have an API sandbox available to test APIs?
API Sandbox is not yet available. We are working to provide an API Sandbox in the near future.
Do I need to create a new user for each Enterprise user who needs access? Can the system provides integration with 3PP user management systems so I can manage users internally?
Yes, a new user account should be provisioned for every requestor. There are no plans yet to integrate to external systems or authentication systems for user management. APIs for user creation and management could be found here.
Is there any Demo instance available for me to try the service?
No, there is no demo instance available. You could see a demo video which shows how the connectivity management services could be beneficial for your enterprise offering here.