C#

This tutorial provides you with a step-by-step walkthrough on how to interact with the IoT Connect 365 API

This is not a production-ready application. Please take your time to make it meet your business requirements and production standards.

Steps

Step 1

Create Your Simple Flask App

keyboard_arrow_down

Before you can access the IoT Connect 365 API, you will need to get the following information:

• Application Token

Enter your credentials in the properties.json file

Step 2

Get the Authentication Token

keyboard_arrow_down

Before you can use the API, you have to fetch an authentication token, by providing:

• Application Token

The authenticate() method will take the application token, which will then be sent to the /authenticate/ endpoint to generate the authentication token

Step 3

Define Controller to Select an Endpoint

keyboard_arrow_down

This code will display a menu to the user and prompt for a choice, showing the list of available items on which the user will perform certain actions

Step 4

Choose Action for Selected Endpoint

keyboard_arrow_down

Prompt the user for an action based on the menu item selected from previous step.

More on IoT Connect 365

For more details about IoT Connect 365 API go to the API Documentation

Code

Download

keyboard_arrow_down

zip tar

iot/properties.json

{
    // _Step_1
    "applicationToken": "",
    "baseUrl": "https://sapiotconnect365.sapdigitalinterconnect.com",
    "setProxy": false,
    "proxyHost": "10.125.30.15",
    "proxyPort": "8080"
}

iot/IOTJson.cs

using System;
using System.Collections.Generic;
using System.Net;
using Newtonsoft.Json;
using Newtonsoft.Json.Linq;
using RestSharp;

namespace iot
{
    public class IOTJson
    {
        private static IOTJson instance;
        private static String applicationToken;
        private static String baseUrl;
        private static String token;
        private static JObject properties;

        public static IOTJson Instance { get => instance; set => instance = value; }
        public static string ApplicationToken { get => applicationToken; set => applicationToken = value; }
        public static string BaseUrl { get => baseUrl; set => baseUrl = value; }
        public static string Token { get => token; set => token = value; }
        public static JObject Properties { get => properties; set => properties = value; }

        public IOTJson(JObject properties)
        {
            Properties = properties;
            baseUrl = properties.GetValue("baseUrl").ToString();
            applicationToken = properties.GetValue("applicationToken").ToString();
        }

        public IOTJson() { }

        public static IOTJson GetInstance()
        {
            if (instance == null)
                instance = new IOTJson();
            return instance;
        }

        // _Step_2
        public static void Authenticate()
        {
            Object payload = new {
                application_token = ApplicationToken
            };
            String payloadData = JsonConvert.SerializeObject(payload);

            String authenticationUrl = BaseUrl + "/api/v1/authenticate";

            RestClient client = new RestClient(authenticationUrl);

            if (properties.GetValue("setProxy").Value<Boolean>()) {
                client.Proxy = new WebProxy("http://" + properties.GetValue("proxyHost").ToString() + ":" + properties.GetValue("proxyPort").ToString());
                client.Proxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
                Console.WriteLine("Using Proxy...");
            }
            RestRequest request = new RestRequest(Method.POST);
            request.AddHeader("content-type", "application/json");
            request.AddParameter("application/json", payloadData, ParameterType.RequestBody);
            Console.WriteLine("Client Data: " + payload.ToString());

            IRestResponse<Dictionary<String, String>> response = client.Execute<Dictionary<String, String>>(request);

            if (response.StatusCode != HttpStatusCode.OK) {
                throw new AuthenticationException("Failed: HTTP error code " + response.StatusCode.ToString() + ";\n" + response.StatusDescription);
            } else {
                Console.WriteLine("Response from server: ");
                Console.WriteLine(JValue.Parse(response.Content).ToString(Formatting.Indented));
                Console.WriteLine("");
                response.Data.TryGetValue("auth_token", out token);
                Console.WriteLine("Token: " + token);
            }
            Console.WriteLine(" ");
        }

        public static void GetRequest(String name, String param)
        {
            String requestUrl = BaseUrl + "/api/v1/" + name + param;

            RestClient client = new RestClient(requestUrl);

            if (properties.GetValue("setProxy").Value<Boolean>()) {
                client.Proxy = new WebProxy("http://" + properties.GetValue("proxyHost").ToString() + ":" + properties.GetValue("proxyPort").ToString());
                client.Proxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
                Console.WriteLine("Using Proxy...");
            }
            RestRequest request = new RestRequest(Method.GET);
            request.AddHeader("accept", "application/json");
            request.AddHeader("Authorization", "Bearer " + token);
            Console.WriteLine(String.Format("Sending Data: {0} to {1}", request.Method.ToString(), requestUrl));

            IRestResponse response = client.Execute(request);

            if (response.StatusCode != HttpStatusCode.OK) {
                Console.WriteLine("Failed: HTTP error code " + response.StatusCode.ToString() + ";\n" + response.StatusDescription);
            } else {
                Console.WriteLine("Response from server: ");
                Console.WriteLine(JValue.Parse(response.Content).ToString(Formatting.Indented));
            }
            Console.WriteLine(" ");
        }

        public static void DeleteRequest(String name, String param)
        {
            String requestUrl = BaseUrl + "/api/v1/" + name + "/" + param;
            Console.WriteLine("URI: " + requestUrl);

            RestClient client = new RestClient(requestUrl);

            if (properties.GetValue("setProxy").Value<Boolean>()) {
                client.Proxy = new WebProxy("http://" + properties.GetValue("proxyHost").ToString() + ":" + properties.GetValue("proxyPort").ToString());
                client.Proxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
                Console.WriteLine("Using Proxy...");
            }
            RestRequest request = new RestRequest(Method.DELETE);
            request.AddHeader("Content-Type", "application/json");
            request.AddHeader("Authorization", "Bearer " + token);
            Console.WriteLine(String.Format("Sending Data: {0} to {1}", request.Method.ToString(), requestUrl));

            IRestResponse response = client.Execute(request);

            if (response.StatusCode != HttpStatusCode.OK) {
                Console.WriteLine("Failed: HTTP error code " + response.StatusCode.ToString() + ";\n" + response.StatusDescription);
            } else {
                Console.WriteLine("Response from server: ");
                Console.WriteLine(JValue.Parse(response.Content).ToString(Formatting.Indented));
            }
            Console.WriteLine(" ");
        }

        public static void PatchRequest(String name, String param, Dictionary<String, String> NVPair)
        {
            String json = "{\n";

            foreach (KeyValuePair<String, String> entry in NVPair) {
                json += ("\"" + entry.Key + "\": " + entry.Value + ",");
            }
            json = json.Remove(json.Length - 1, 1);
            json += "\n}";


            String requestUrl = BaseUrl + "/api/v1/" + name + "/" + param;
            Console.WriteLine("URI: " + requestUrl);

            RestClient client = new RestClient(requestUrl);

            if (properties.GetValue("setProxy").Value<Boolean>()) {
                client.Proxy = new WebProxy("http://" + properties.GetValue("proxyHost").ToString() + ":" + properties.GetValue("proxyPort").ToString());
                client.Proxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
                Console.WriteLine("Using Proxy...");
            }
            RestRequest request = new RestRequest(Method.PATCH);
            request.AddHeader("Content-Type", "application/json");
            request.AddHeader("Authorization", "Bearer " + token);
            request.AddParameter("application/json", json, ParameterType.RequestBody);
            Console.WriteLine(String.Format("Sending Data: {0} to {1}", request.Method.ToString(), requestUrl));

            IRestResponse response = client.Execute(request);

            if (response.StatusCode != HttpStatusCode.OK) {
                Console.WriteLine("Failed: HTTP error code " + response.StatusCode.ToString() + ";\n" + response.StatusDescription);
            } else {
                Console.WriteLine("Response from server: ");
                Console.WriteLine(JValue.Parse(response.Content).ToString(Formatting.Indented));
            }
            Console.WriteLine(" ");
        }

        public static void PatchRequest(String name, String param)
        {
            String requestUrl = BaseUrl + "/api/v1/" + name + "/" + param;
            Console.WriteLine("URI: " + requestUrl);

            RestClient client = new RestClient(requestUrl);

            if (properties.GetValue("setProxy").Value<Boolean>()) {
                client.Proxy = new WebProxy("http://" + properties.GetValue("proxyHost").ToString() + ":" + properties.GetValue("proxyPort").ToString());
                client.Proxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
                Console.WriteLine("Using Proxy...");
            }
            RestRequest request = new RestRequest(Method.PATCH);
            request.AddHeader("Content-Type", "application/json");
            request.AddHeader("Authorization", "Bearer " + token);
            request.AddParameter("application/json", "", ParameterType.RequestBody);
            Console.WriteLine(String.Format("Sending Data: {0} to {1}", request.Method.ToString(), requestUrl));

            IRestResponse response = client.Execute(request);

            if (response.StatusCode != HttpStatusCode.OK) {
                Console.WriteLine("Failed: HTTP error code " + response.StatusCode.ToString() + ";\n" + response.StatusDescription);
            } else {
                Console.WriteLine("Response from server: ");
                Console.WriteLine(JValue.Parse(response.Content).ToString(Formatting.Indented));
            }
            Console.WriteLine(" ");
        }

        public static void PostRequest(String name, Dictionary<String, String> NVPair)
        {
            String requestUrl = BaseUrl + "/api/v1/" + name;
            Console.WriteLine("URI: " + requestUrl);

            RestClient client = new RestClient(requestUrl);

            if (properties.GetValue("setProxy").Value<Boolean>()) {
                client.Proxy = new WebProxy("http://" + properties.GetValue("proxyHost").ToString() + ":" + properties.GetValue("proxyPort").ToString());
                client.Proxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
                Console.WriteLine("Using Proxy...");
            }
            RestRequest request = new RestRequest(Method.POST);
            request.AddHeader("Content-Type", "application/json");
            request.AddHeader("Authorization", "Bearer " + token);
            request.AddParameter("application/json", "", ParameterType.RequestBody);
            Console.WriteLine(String.Format("Sending Data: {0} to {1}", request.Method.ToString(), requestUrl));

            IRestResponse response = client.Execute(request);

            if (response.StatusCode != HttpStatusCode.OK) {
                Console.WriteLine("Failed: HTTP error code " + response.StatusCode.ToString() + ";\n" + response.StatusDescription);
            } else {
                Console.WriteLine("Response from server: ");
                Console.WriteLine(JValue.Parse(response.Content).ToString(Formatting.Indented));
                Console.WriteLine("Headers:");
                foreach (Parameter header in response.Headers) {
                    Console.WriteLine("Name: " + header.Name + ", Value: " + header.Value);
                }
            }
            Console.WriteLine(" ");
        }
    }

    public class AuthenticationException : Exception
    {
        public AuthenticationException()
        {

        }

        public AuthenticationException(String message) : base(String.Format("Authentication Error, {0}", message))
        {

        }
    }
}

iot/IOTConsole.cs

using System;
using System.Collections.Generic;
using System.IO;
using System.Web;
using Newtonsoft.Json.Linq;

namespace iot
{
    public class IOTConsole
    {
        public JObject properties;

        public IOTConsole()
        {
            properties = JObject.Parse(File.ReadAllText(@"../../properties.json"));
        }

        public void StartConsole()
        {
            IOTJson.Properties = properties;
            IOTJson.BaseUrl = properties.GetValue("baseUrl").ToString();
            IOTJson.ApplicationToken = properties.GetValue("applicationToken").ToString();
            Boolean loop = true;

            // _Step_3
            while (loop) {
                Console.WriteLine("---------Main Menu--------");
                Console.WriteLine("1. Endpoint");
                Console.WriteLine("2. SIM");
                Console.WriteLine("3. Events");
                Console.WriteLine("4. ServiceLookup");
                Console.WriteLine("5. Exit");
                Console.WriteLine("");
                Console.Write("Enter your choice: ");
                String choice = Console.ReadLine();

                if (choice.Trim().Equals("1")) {
                    EndpointOp();
                } else if (choice.Trim().Equals("2")) {
                    SimOp();
                } else if (choice.Trim().Equals("3")) {
                    EventOp();
                } else if (choice.Trim().Equals("4")) {
                    LookupOp();
                } else if (choice.Trim().Equals("5")) {
                    loop = false;
                }
            }
        }

        // _Step_4
        private static void EndpointOp()
        {
            try {
                Boolean loop = true;
                while (loop) {
                    Console.WriteLine("------------Endpoint---------------");
                    Console.WriteLine("1. Create Endpoint");
                    Console.WriteLine("2. Delete Endpoint By ID");
                    Console.WriteLine("3. Retrive Endpoint By ID");
                    Console.WriteLine("4. Retrive Endpoint By Name");
                    Console.WriteLine("5. Update Endpoint By ID");
                    Console.WriteLine("6. Go to Main Menu");
                    Console.WriteLine("");
                    Console.Write("Endpoint | Enter your choice: ");

                    String choice = Console.ReadLine();

                    if (IOTJson.Token == null) {
                        IOTJson.Authenticate();
                    }

                    if (choice.Trim().Equals("1")) {
                        Dictionary<String, String> NVPare = new Dictionary<String, String>();

                        Console.Write("Enter the name (required): ");
                        String name = Console.ReadLine();
                        name = makeValue(name, false);
                        if (!String.IsNullOrWhiteSpace(name)) {
                            NVPare.Add("name", name);
                        }

                        Console.Write("Enter the status (required) 0 Enable, 1 Disable: ");

                        String status = Console.ReadLine();
                        if (!String.IsNullOrWhiteSpace(status)) {
                            status = "{ \"id\":" + status + " }";
                            NVPare.Add("status", status);
                        }

                        Console.Write("Enter the service profile (required): ");

                        String service_profile = Console.ReadLine();
                        service_profile = makeValue(service_profile, true);
                        if (!String.IsNullOrWhiteSpace(service_profile)) {
                            NVPare.Add("service_profile", service_profile);
                        }

                        Console.Write("Enter the tariff profile (required): ");

                        String tariff_profile = Console.ReadLine();
                        tariff_profile = makeValue(tariff_profile, true);

                        if (!String.IsNullOrWhiteSpace(tariff_profile)) {
                            NVPare.Add("tariff_profile", tariff_profile);
                        }

                        Console.Write("Enter the SIM ID: ");

                        String sim = Console.ReadLine();
                        sim = makeValue(sim, true);
                        if (!String.IsNullOrWhiteSpace(sim)) {
                            NVPare.Add("sim", sim);
                        }
                        IOTJson.PostRequest("endpoint", NVPare);

                    } else if (choice.Trim().Equals("2")) {

                        Console.Write("Enter the EndpointID: ");

                        choice = Console.ReadLine();
                        IOTJson.DeleteRequest("endpoint", choice);

                    } else if (choice.Trim().Equals("3")) {
                        Console.Write("Enter the EndpointID: ");

                        choice = Console.ReadLine();
                        IOTJson.GetRequest("endpoint/", choice);

                    } else if (choice.Trim().Equals("4")) {
                        Console.Write("Enter the Endpoint Name: ");

                        String name = Console.ReadLine();
                        IOTJson.GetRequest("endpoint?", "q=name:" + HttpUtility.UrlEncode(name));

                    } else if (choice.Trim().Equals("5")) {
                        Console.Write("Enter the Endpoint ID: ");

                        String endpointID = Console.ReadLine();

                        Dictionary<String, String> NVPare = new Dictionary<String, String>();
                        Console.Write("Enter the name: ");

                        String name = Console.ReadLine();

                        if (name != null) {
                            NVPare.Add("name", name);
                        }

                        Console.Write("Enter the status (0: Enable, 1: Disalbe): ");

                        String status = Console.ReadLine();
                        if (!String.IsNullOrWhiteSpace(status)) {
                            status = "{ \"id\":" + status + " }";
                            NVPare.Add("status", status);
                        }
                        Console.Write("Enter the sevice profile ");

                        String service_profile = Console.ReadLine();
                        service_profile = makeValue(service_profile, true);
                        if (service_profile != null) {
                            NVPare.Add("service_profile", service_profile);
                        }
                        Console.Write("Enter the tariff profile: ");

                        String tariff_profile = Console.ReadLine();
                        tariff_profile = makeValue(tariff_profile, true);
                        if (tariff_profile != null) {
                            NVPare.Add("tariff_profile", tariff_profile);
                        }

                        Console.Write("Enter the SIM ID: ");

                        String sim = Console.ReadLine();
                        sim = makeValue(sim, true);
                        if (sim != null) {
                            NVPare.Add("sim", sim);
                        }

                        IOTJson.PatchRequest("endpoint", endpointID, NVPare);
                    } else if (choice.Trim().Equals("6")) {
                        loop = false;
                    }
                }
            } catch (AuthenticationException ex) {
                Console.WriteLine(ex.Message);
            }


        }

        private static void SimOp()
        {
            try {
                Boolean loop = true;

                while (loop) {
                    Console.WriteLine("------------SIM---------------");
                    Console.WriteLine("1. Retrive SIM By ICCID");
                    Console.WriteLine("2. Retrive SIM By ID");
                    Console.WriteLine("3. Activate SIM By ID");
                    Console.WriteLine("4. Suspend SIM By ID");
                    Console.WriteLine("5. Register SIM");
                    Console.WriteLine("6. Go to Main Menu");
                    Console.WriteLine("");
                    Console.Write("SIM | Enter your choice: ");

                    String choice = Console.ReadLine();

                    if (IOTJson.Token == null) {
                        IOTJson.Authenticate();
                    }

                    if (choice.Trim().Equals("1")) {
                        Console.Write("Enter the iccid# ");
                        String iccid = Console.ReadLine();
                        IOTJson.GetRequest("sim?", "q=iccid:" + iccid);
                    } else if (choice.Trim().Equals("2")) {
                        Console.Write("Enter the SIM ID:");
                        choice = Console.ReadLine();
                        IOTJson.GetRequest("sim/", choice);
                    } else if (choice.Trim().Equals("3")) {
                        Console.Write("Enter the SIM ID: ");
                        choice = Console.ReadLine();
                        Dictionary<String, String> NVPair = new Dictionary<String, String>();
                        String returnValue = "{ \"id\": 1 }";
                        NVPair.Add("status", returnValue);
                        IOTJson.PatchRequest("sim", choice, NVPair);
                    } else if (choice.Trim().Equals("4")) {
                        Console.Write("Enter the SIM ID: ");
                        choice = Console.ReadLine();
                        Dictionary<String, String> NVPair = new Dictionary<String, String>();
                        String returnValue = "{ \"id\": 2 }";
                        NVPair.Add("status", returnValue);
                        IOTJson.PatchRequest("sim", choice, NVPair);
                    } else if (choice.Trim().Equals("5")) {
                        Console.Write("Enter the BIC Code without hyphen: ");
                        choice = Console.ReadLine();
                        IOTJson.PatchRequest("sim_batch/bic/", choice);
                    } else if (choice.Trim().Equals("6")) {
                        loop = false;
                    }
                }
            } catch (AuthenticationException ex) {
                Console.WriteLine(ex.Message);
            }
        }

        private static void EventOp()
        {
            try {
                Boolean loop = true;
                while (loop) {
                    Console.WriteLine("----------------Event--------------------");
                    Console.WriteLine("1. Retrive Events By Endpoint");
                    Console.WriteLine("2. Retrive Events By ICCID");
                    Console.WriteLine("3. Retrive EventTypes");
                    Console.WriteLine("4. Retrive Events By Type");
                    Console.WriteLine("5. Retrive Event By Event ID");
                    Console.WriteLine("6. Go to Main Menu");
                    Console.WriteLine("");
                    Console.Write("Event | Enter your choice: ");

                    String choice = Console.ReadLine();

                    if (IOTJson.Token == null) {
                        IOTJson.Authenticate();
                    }

                    if (choice.Trim().Equals("1")) {
                        Console.Write("Enter the Endpoint Name: ");
                        String name = Console.ReadLine();
                        IOTJson.GetRequest("event?", "q=endpoint:" + HttpUtility.UrlEncode(name));
                    } else if (choice.Trim().Equals("2")) {
                        Console.Write("Enter the ICCID: ");
                        String iccid = Console.ReadLine();
                        IOTJson.GetRequest("event?", "q=iccid:" + iccid);
                    } else if (choice.Trim().Equals("3")) {
                        IOTJson.GetRequest("event/", "type");
                    } else if (choice.Trim().Equals("4")) {
                        Console.Write("Enter the EventType (0 - 10): ");
                        String type = Console.ReadLine();
                        IOTJson.GetRequest("event?", "q=type:" + type);
                    } else if (choice.Trim().Equals("5")) {
                        Console.Write("Enter the EventID: ");
                        String id = Console.ReadLine();
                        IOTJson.GetRequest("event?", "q=id:" + id);
                    } else if (choice.Trim().Equals("6")) {
                        loop = false;
                    }
                }
            } catch (AuthenticationException ex) {
                Console.WriteLine(ex.Message);
            }
        }

        private static void LookupOp()
        {
            try {


                Boolean loop = true;
                while (loop) {
                    Console.WriteLine("---------------Lookup-----------------");
                    Console.WriteLine("1. Lookup Available Countries");
                    Console.WriteLine("2. Lookup Available Currencies");
                    Console.WriteLine("3. Lookup Available Data Blocksizes");
                    Console.WriteLine("4. Lookup Available Data Throttles");
                    Console.WriteLine("5. Lookup Available Operators");
                    Console.WriteLine("6. Go to Main Menu");
                    Console.WriteLine("");
                    Console.Write("Lookup | Enter your choice: ");

                    String choice = Console.ReadLine();

                    if (IOTJson.Token == null) {
                        IOTJson.Authenticate();
                    }

                    if (choice.Trim().Equals("1")) {
                        IOTJson.GetRequest("country", "");
                    } else if (choice.Trim().Equals("2")) {
                        IOTJson.GetRequest("currency", "");
                    } else if (choice.Trim().Equals("3")) {
                        IOTJson.GetRequest("data_blocksize", "");
                    } else if (choice.Trim().Equals("4")) {
                        IOTJson.GetRequest("data_throttle", "");
                    } else if (choice.Trim().Equals("5")) {
                        IOTJson.GetRequest("operator", "");
                    } else if (choice.Trim().Equals("6")) {
                        loop = false;
                    }
                }
            } catch (AuthenticationException ex) {
                Console.WriteLine(ex.Message);
            }
        }

        private static String makeValue(String value, Boolean isInt)
        {
            String returnValue = null;
            if (!String.IsNullOrWhiteSpace(value)) {
                if (isInt)
                    returnValue = "{ \"id\":" + value + " }";
                else
                    returnValue = "\"" + value + "\"";
            }
            return returnValue;
        }
    }
}