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


export class AccessTokenResponse
{
    public accessToken: string;
    public scope: string;
    public tokenType: string;
    public expiresIn: number;
    public httpStatusCode: number;
    public httpErrorReason: string;
    public error: string;

    public constructor(init?: Partial<AccessTokenResponse>) { (Object as any).assign(this, init); }
}

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

    /** @description Post parameters in body */
    // @ApiMember(Description="Post parameters in body", ParameterType="model")
    public clientSecret: string;

    /** @description Post parameters in body */
    // @ApiMember(Description="Post parameters in body", ParameterType="model")
    public scope: string;

    public constructor(init?: Partial<GetAuthToken>) { (Object as any).assign(this, init); }
}

TypeScript 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>