Retrieve the certificate of a device or a software service in the ETX system.
With this API call the user can check the certificate of the device. At least one of the DeviceID, IMEI, ICCID or IMSI is required to make the call.
Note: The user needs to authenticate with their ThingSpace credentials using the Access/Bearer and Session/M2M tokens in order to call this API.
Authorization
thingspace_oauth sessionToken This is the ThingSpace token, from Credentials and Tokens is used
In: header
This is the Session/M2M token needed to authenticate the user. It should be acquired by using the ThingSpace APIs. For detail on how to obtain a Session/M2M token please refer to the
- ThingSpace Quick Start Guide - Obtaining a VZ-M2M Session Token Programmatically
- or the ThingSpace API Video Guide 1 and ThingSpace API Video Guide 2
In: header
Query Parameters
One of the following IDs is required- DeviceID, IMEI, ICCID, IMSI. If more than one ID is provided, the API will return the certificate for the first ID found. The IDs are evaluated in the following order: DeviceID, IMEI, ICCID, IMSI. If the first provided ID is not found, the API will return an error.
Header Parameters
The VendorID set during the Vendor registration call.
^[a-zA-Z0-9]+$length <= 64Optional transaction identifier for tracing requests. If not provided, the application will generate one.
uuidResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/api/v2/clients/registration?DeviceID=a4fcd16a-343d-4527-8203-2f46e3e4ff4b&IMEI=12-345678-901234-5&ICCID=89345678901234567890&IMSI=123456789012345" \ -H "VendorID: VerizonETX"{ "DeviceID": "a4fcd16a-343d-4527-8203-2f46e3e4ff4b", "Certificate": { "cert.pem": "\"-----BEGIN CERTIFICATE-----\nMIIDrjCCApagAwIBAgICEAEwDQYJKoZIhvcNAQELBQAwUjELMAkGA1UEBhMCQVUx\n...\nuuA1Zog3aBOeeEzp9SEJBMTJRYPXbK4e8Xer+7m98OL/3g==\n-----END CERTIFICATE-----\"\n", "key.pem": "\"-----BEGIN PRIVATE KEY-----\nMIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDa1lF7DWudshQ5\n...\nJbjD2hacWGzpKzTfn5Mt1frE\n-----END PRIVATE KEY-----\"\n", "ca.pem": "\"-----BEGIN CERTIFICATE-----\nMIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDa1lF7DWudshQ5\n...\nJbjD2hacWGzpKzTfn5Mt1frE\n-----END CERTIFICATE-----\"\n", "ExpirationTime": "2017-07-21T17:32:28Z" }, "ClientType": "Vehicle", "ClientSubtype": "PassengerCar", "VendorID": "VerizonETX"}Update a configuration PUT
This endpoint updates an existing configuration. Similar to POST, the updated data for the configuration should be provided as JSON in the body of the PUT request. The configuration ID parameter, which was provided by the POST (create) operation, is required to do any updates on the configuration. Note: The user needs to authenticate with their ThingSpace credentials using the Access/Bearer and Session/M2M tokens in order to call this API.
Register a device or a software service to the ETX system. POST
With this API call the user (client) registers its device or software service to the ETX system. Therefore, when a connection is initiated from the device or software service to the ETX system along with the credential provided by this registration call, then the connection will be authorized. - The user can register multiple devices or software services, which can all be used at the same time. - There rules set in the system that limit the type and subtype of the clients that are allowed to be registered under the VendorID. The rules are created based ont he agreement between the Vendor and Verizon. - The user will only be able to register a limited number of devices or software services under the same VendorID. This registration limit is specified by the agreement between the Vendor and Verizon. Note: The user needs to authenticate with their ThingSpace credentials using the Access/Bearer and Session/M2M tokens in order to call this API.