AuthApi.md

IO.Swagger.Api.AuthApi

All URIs are relative to https://api.thesmsworks.co.uk/v1

Method	HTTP request	Description
KeySecret	GET /auth/getApiKey
Login	POST /auth/token

KeySecret

ApiKeyResponse KeySecret (string customerid)

Generates an API Key/Secret pair

Example

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class KeySecretExample
    {
        public void main()
        {
            var apiInstance = new AuthApi();
            var customerid = customerid_example;  // string | The Customer ID

            try
            {
                ApiKeyResponse result = apiInstance.KeySecret(customerid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthApi.KeySecret: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
customerid	string	The Customer ID

Return type

ApiKeyResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json;charset=UTF-8

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Login

TokenResponse Login (Login credentials)

Generates a Json Web Token

Example

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class LoginExample
    {
        public void main()
        {
            var apiInstance = new AuthApi();
            var credentials = new Login(); // Login | API Key & Secret

            try
            {
                TokenResponse result = apiInstance.Login(credentials);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthApi.Login: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
credentials	Login	API Key & Secret

Return type

TokenResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json;charset=UTF-8

[Back to top] [Back to API list] [Back to Model list] [Back to README]