Skip to content

Integration API Documentation

Table of Contents

Top

integration.proto

Azure

For Azure IoT & Azure Device Provisioning Service

Field Type Label Description
csrSigningCertificate bytes this is the certificate used to sign the CSR to issue device certificates
privateKey bytes this is the private key used to sign the CSR to issue device certificates

Hawkbit

For Hawkbit Server

Field Type Label Description
hawkbitURL string hawkbit server URL & port information e.g. https://localhost:8080
username string username from Hawkbit server
password string password from Hawkbit server

IntegrationDetails

IntegrationDetails contains information on integration with 3rd party platforms

Field Type Label Description
hawkbitTargetSecretKey string a target in Hawkbit is device, when a device is pre-provisioned it will create a secret key which is specific to each device
deviceCertificateSigningRequest string this is the certificate signing request received from the agent.
deviceCertificate bytes if Azure is enabled, and agent is approved, scurid server will sign the request to generate the certificate, which we can store here
integrationStatus IntegrationStatus
thingworxApplicationKey string this is the device application key issued from ThingWorx
thingworxAppKeyName string this is the name of the app key in ThingWorx
csrCustom certificate.v1.CSRCustom this is the custom CSR information

IntegrationStatus

IntegrationStatus should be used to track which 3rd party integrations are enabled.

Field Type Label Description
thingWorxEnabled bool is thingworx integration enabled
hawkbitEnabled bool is hawkbit integration enabled
azureEnabled bool is azure integration enabled

ThingWorx

For Thingworx Server

Field Type Label Description
thingWorxURL string thingworx server and port information e.g. https://localhost:443/Thingworx
appKey string thingworx app key created for Scurid server to authenticate with
useThingWorxEntityNameToDownloadAppKey bool if true, then the app key will be downloaded from thingworx using the entity name

Scalar Value Types

.proto Type Notes C++ Java Python Go C# PHP Ruby
double double double float float64 double float Float
float float float float float32 float float Float
int32 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. int32 int int int32 int integer Bignum or Fixnum (as required)
int64 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. int64 long int/long int64 long integer/string Bignum
uint32 Uses variable-length encoding. uint32 int int/long uint32 uint integer Bignum or Fixnum (as required)
uint64 Uses variable-length encoding. uint64 long int/long uint64 ulong integer/string Bignum or Fixnum (as required)
sint32 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. int32 int int int32 int integer Bignum or Fixnum (as required)
sint64 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. int64 long int/long int64 long integer/string Bignum
fixed32 Always four bytes. More efficient than uint32 if values are often greater than 2^28. uint32 int int uint32 uint integer Bignum or Fixnum (as required)
fixed64 Always eight bytes. More efficient than uint64 if values are often greater than 2^56. uint64 long int/long uint64 ulong integer/string Bignum
sfixed32 Always four bytes. int32 int int int32 int integer Bignum or Fixnum (as required)
sfixed64 Always eight bytes. int64 long int/long int64 long integer/string Bignum
bool bool boolean boolean bool bool boolean TrueClass/FalseClass
string A string must always contain UTF-8 encoded or 7-bit ASCII text. string String str/unicode string string string String (UTF-8)
bytes May contain any arbitrary sequence of bytes. string ByteString str []byte ByteString string String (ASCII-8BIT)