Introduction and requirements

To create IoT files you need to follow some steps and have some critical information like API KEYS, and AWS account with access to s3 in our Thrive AWS account. Also you will need some information from the client, here is what you need:

• Client name (Like his enterprise name)
• Client ID
• Facility ID
• Client email

Accounts and keys

Before to start you also need some account and keys to get files in s3 and call endpoints

• To access to our AWS account, you need an AWS account with privileges to read files in S3
• To call API Endpoints you need the API KEY

API endpoints

The API endpoints described below is where all the process to create facilities, clients and files in our databases and system happens so you need to be very carefull on fill the fields with the correct information because actually we don’t have endpoints to remove it, they need to be removed manually if you want to delete it.

Create Client

The first step is create the client, to do this you need to call the API endpoint described above and fill the fields with your clients information

curl --location --request POST '<https://api-cc-iot.greenmarimba2.com/v1/clients>' \\
--header 'x-api-key: --API-KEY--' \\
--header 'Content-Type: application/json' \\
--data-raw '{
    "clientId": "client-tc000",
    "clientName": "Client name",
    "email": "[email protected]"
}'

Create facility

Next step is to create your facility registration in our system, so the process is similar than the described before: You need to call this API endpoint and fill the fields with your client and facility information

curl --location --request POST '<https://api-cc-iot.greenmarimba2.com/v1/facilities>' \\
--header 'x-api-key: --API-KEY--' \\
--header 'Content-Type: application/json' \\
--data-raw '{
    "facilityId": "tc000",
    "name": "Client name",
    "clientId": "client-tc000"
}'

Create device