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

"use strict";
export class AccessTokenResponse {
    /** @param {{accessToken?:string,scope?:string,tokenType?:string,expiresIn?:number,httpStatusCode?:number,httpErrorReason?:string,error?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    accessToken;
    /** @type {string} */
    scope;
    /** @type {string} */
    tokenType;
    /** @type {number} */
    expiresIn;
    /** @type {number} */
    httpStatusCode;
    /** @type {string} */
    httpErrorReason;
    /** @type {string} */
    error;
}
export class GetAuthToken {
    /** @param {{clientId?:string,clientSecret?:string,scope?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Post parameters in body */
    clientId;
    /**
     * @type {string}
     * @description Post parameters in body */
    clientSecret;
    /**
     * @type {string}
     * @description Post parameters in body */
    scope;
}

JavaScript 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
}