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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<GetAuthToken xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DX.STF.Application.ClientApi.Messages.Authentication">
  <ClientId>String</ClientId>
  <ClientSecret>String</ClientSecret>
  <Scope>String</Scope>
</GetAuthToken>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AccessTokenResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DX.STF.Application.ClientApi.ResponseMessages.Authentication">
  <AccessToken>String</AccessToken>
  <Error>String</Error>
  <ExpiresIn>0</ExpiresIn>
  <HttpErrorReason>String</HttpErrorReason>
  <HttpStatusCode>0</HttpStatusCode>
  <Scope>String</Scope>
  <TokenType>String</TokenType>
</AccessTokenResponse>