Polte SuperRes (SR) Quick Start Guide

1A. Request an Account

• You should already have a Polte IoT Cloud (PIC) account to use the SuperRes (SR) Quick Start Guide. If you don’t, you can contact us to request an account here.
• Once complete, log in to the PIC at https://polte.io./.

1B. Initiate Bulk Claim

• Next, to claim your device IMEI (UE): Click on the User Equipment tab → Bulk Claim.
• Choose the Identifier type or IMEIs in a CSV file and upload.
• Choose the Product Definition and click on the Submit button.
• You can track the location of the device on the Mapping interface.
• Navigate to User Equipment → UE Map view. Select the device on the map.

1C. Directions for Third-Party Integrators

If you are a third-party integrator with Polte, read on.

To consume Polte APIs, you have to authorize with an API token for consuming REST API calls. The format for authorization from a third-party is Polte-API  <API-token inserted here without the brackets>.

• Go to the customer endpoint URL: https://polte.io/swagger/customer/
• Before trying out any APIs, you need the customer ID and the API Token from the PIC. On the PIC portal, on the top-right of the profile, click on the Customer Profile.
• Copy the Customer ID.
• Create an API Token on the API Tokens tab. Copy the Token.
• On Swagger, click on the Authorize button to authorize using the format Polte-API  <API-Token>.
• You can claim your device as mentioned in the steps above OR you can claim your device with the REST API call.

POST /customer/{customerId}/userEquipment/claim

curl -X POST "https://polte.io/api/v1/customer/<customer_id>/userEquipment/claim" \
-H "accept: application/json" \
-H "Authorization: Polte-API <API-token>" \
-H "Content-Type: application/json" \
-d "{\"productDefinitionId\":\"
<productDefinitionId>\",\"identifiers\": [ \"<identifiers>\"
],\"type\":\"IMEI\"}"

2A. Create API Token

• To register your device, the MCU triggers the AT+POLTEREG? command to the chipset (Sequans).
• The chipset sends back the registration tokens which are in turn sent to the integratorʼs cloud.
• To register your device using the Polte API, create an API token.
• Go to https://polte.io/swagger/customer/
• Call the API to create additional API tokens or you can create one on the PIC portal as discussed above.

POST /customer/{customerId}/apiTokens

curl -X POST https://polte.io/api/v1/customer/<customer_id>/apiTokens \
-H "accept: application/json" \
-H "Authorization: Polte-API <API-token>" \
-H "Content-Type: application/json" \ -d "{ "role": "UE"}”

2B. Copy the API Token

• Copy the API token from the API response.
• Return to UE endpoint URL, https://polte.io/swagger/user-equipment/ and enter the API-Token in the format shown.
• IMPORTANT: The token format is Polte-API <API-token>.
• You are authorized to call UE APIs.
• You can now register the device.
• Go to: https://polte.io/swagger/user-equipment/

Call the register API, GET /ue/register/

curl -X GET "https://polte.io/api/v1/ue/register?manufacturerToken=<manufacturer_token> \
&modelToken=<model_token>&ueToken=<ue_token>&identifierValue=<identifierValue>&identifierType=<identifierType>" \
-H "accept: application/json" \
-H "Authorization: Polte-API <API-Token>"

• The Polte server will return the MQTT tokens (mqttAuthUser:mqttAuthPassword) which are needed for interacting with the
 locate APIs.

3A. Create X-UE-Auth String

• To get the location of the device, payload data is sent over AT+POLTECOMPRESS command.
• Create X-UE-Auth string which is base64 encoding of mqtt tokens (mqttAuthUser:mqttAuthPassword).

3B. Request Location

• Request API call to return the location (lat/long).

POST /ue/{ueToken}/locate

curl -X POST "https://polte.io/api/v1/ue/<ue_token>/locate?sync=true" \
-H "accept: application/json" \
-H "X-UE-Auth: base64 encoded mqttAuthUser:mqttAuthPassword" \
-H "Authorization: Polte-API <API-Token>" \
-H "Content-Type: application/json" \
-d "{ \"payload\": \"payload from device\"}"

• View the location on the mapping interface on the PIC.

Polte provides you with Swagger, an interactive tool to test drive the Polte Location API.

Have questions using the Polte SR Quick Start Guide? Help is only a click away. Reach out to our Support team here.