E T X Registration

Unregister a list of devices and software services from the ETX system.

DELETE
/api/v2/clients/registration

With this API call the user (client) can unregister its devices and software services from the ETX system. The unregistered devices and services will no longer be able to use the ETX Message Exchange.

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
AuthorizationBearer <token>

This is the ThingSpace token, from Credentials and Tokens is used

In: header

SessionToken<token>

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

In: header

Query Parameters

DeviceIDs*array<>

The list of device IDs and software service IDs to be unregistered

Items1 <= items <= 100

Header Parameters

VendorID*string

The VendorID set during the Vendor registration call.

Match^[a-zA-Z0-9]+$
Lengthlength <= 64
X-Transaction-Id?string

Optional transaction identifier for tracing requests. If not provided, the application will generate one.

Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/api/v2/clients/registration?DeviceIDs=497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "VendorID: VerizonETX"
Empty

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.

Renew a device certificate or complete the registration for a device with pending certificate PUT

With this API call the user (client) can: - renew the certificate of a device or software service in the ETX system if the original certificate has expired. If the client's certificate expired or going to expire within 30 days and new certificate will be issued. If the certificate expires more than 30 days, the current certificate will be returned to the client. - complete its device or software service registration to the ETX system if the original registration request was not successful because of a pending certificate generation. Whenever the user receives a "client registration is pending" response (HTTP 202) from POST /clients/registration call. The client should initiate this PUT API call to finish the registration process and get the required certificate. Note: The user needs to authenticate with their ThingSpace credentials using the Access/Bearer and Session/M2M tokens in order to call this API.