DX STF Client API

GetAuthToken

Auth Requests

Auth

The following routes are available for this service:
POST	/api/authentication/token	Get Bearer access token, contact support for credentials

import Foundation
import ServiceStack

/**
* Auth
*/
// @Api(Description="Auth")
// @ApiResponse(Description="Access token response", IsDefaultResponse=true, StatusCode=200)
public class GetAuthToken : Codable
{
    /**
    * Post parameters in body
    */
    // @ApiMember(Description="Post parameters in body", ParameterType="model")
    public var clientId:String

    /**
    * Post parameters in body
    */
    // @ApiMember(Description="Post parameters in body", ParameterType="model")
    public var clientSecret:String

    /**
    * Post parameters in body
    */
    // @ApiMember(Description="Post parameters in body", ParameterType="model")
    public var scope:String

    required public init(){}
}

public class AccessTokenResponse : Codable
{
    public var accessToken:String
    public var scope:String
    public var tokenType:String
    public var expiresIn:Int
    public var httpStatusCode:Int
    public var httpErrorReason:String
    public var error:String

    required public init(){}
}

Swift GetAuthToken DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/authentication/token HTTP/1.1 
Host: stf-api-uat.data-xchange.co.za 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	clientId: String,
	clientSecret: String,
	scope: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	accessToken: String,
	scope: String,
	tokenType: String,
	expiresIn: 0,
	httpStatusCode: 0,
	httpErrorReason: String,
	error: String
}