Frequently Asked Questions (FAQs)

How do I get an API key?

When you request time in the Control Center sandbox, DevNet creates a user account and an API key for you. You will receive an email containing your user name and the corresponding API key.

What URL do I use?

All sandbox APIs use the following URL:

Copyhttps://rws-jpotest.jasper.com/rws/api/

How do I make a sandbox reservation?

Go to the Control Center sandbox and click the RESERVE button in the upper right corner. For more details, see Making a Reservation.

How long does my sandbox reservation last?

Your API key and user account are active for 30 days from the start of your sandbox reservation. The email you receive from DevNet contains the expiration date for your API key, which applies to your user account as well.

Can I extend my sandbox reservation time?

As long as your API key is still active, you can access the sandbox, regardless of the duration of your reservation. If you request another reservation, DevNet will send you the existing API key, if it is still active. Check the email to find out when the API key expires.

If your original API key has expired, DevNet will reactivate your user account and send you a new API key. To continue using your existing code, you must replace the authorization header value with a new one based on the new API key (see Authentication). Also, be aware that DevNet resets the Control Center data for each sandbox reservation.

Can I reactivate my user account after it expires?

Yes. DevNet reactivates your user account so you can use the same user name as before. However, DevNet will send you a new API key. If you want to reuse any code from an earlier sandbox session, make sure to replace the authorization header value with a new one based on the new API key (see Authentication).

Will I lose my data changes if I request a new reservation?

Yes. DevNet resets the Control Center data for each sandbox reservation. Be aware that you may see different devices in your account.

Can I use the APIs for bulk operations?

You can run the REST APIs on only one device (ICCID) at a time.

Is there a limit to the number of calls?

Please limit the number of calls per second to 5 and the number of concurrent calls to 1 (in other words, only one call at a time).

Can I filter the responses?

Yes. You can request partial responses to limit the amount of information returned. For example, if you want to get the rate plan for a particular device, you can instruct the Get Device Details function to return the rate plan name only and no other fields. See Partial Response Guidelines.

How does authentication work?

You must combine your user name and API key into a single string and then encode the result. For more details, see Authentication.

How does pagination work?

In the request, you specify the number of results the function should include in a page and the number of the page to return. The response includes the page number and a flag indicating whether that page is the last. For more information, see Pagination.

What API version number should I use?

The current version number (apiVersion) for all Control Center APIs is 1.

Can I use real SIMs with the APIs?

Not in the sandbox environment. This environment uses virtual SIMs and devices with randomly generated usage to simulate a real IoT device deployment. If you want to experiment with actual SIMs, you can order a Control Center starter kit from one of the mobile network operators we work with. The starter kit includes several test SIMs with connectivity through the operator's network. You have full access to the Control Center web interface as well as the complete set of enterprise APIs. Learn more about starter kits.

What's the difference between Essential and Advantage accounts?

Control Center offers two different types of enterprise accounts to address different market segments and use cases:

• Essential for simple IoT deployments. These deployments are characterized by devices with low data usage, high latency tolerance, and predictable behavior — on a massive scale. Market segments include smart meters, environmental monitoring, and asset tracking.
• Advantage for complex IoT deployments. Complex IoT devices typically require high volumes of data, low latency, and superior reliability. Market segments include connected car, connected healthcare, and payment solutions.

See Essential vs. Advantage Accounts to learn more about various IoT use cases and the functionality associated with the different types of Control Center accounts.

Can I access the Control Center web interface?

No. Sandbox users have access to the Control Center APIs only. To access the Control Center web interface, consider ordering a starter kit. Learn more about starter kits.