DX STF Client API

<back to all web services

GetAuthToken

Auth Requests

Auth

The following routes are available for this service:
POST/api/authentication/tokenGet Bearer access token, contact support for credentials
GetAuthToken Parameters:
NameParameterData TypeRequiredDescription
ClientIdmodelstringYesPost parameters in body
ClientSecretmodelstringYesPost parameters in body
ScopemodelstringYesPost parameters in body
AccessTokenResponse Parameters:
NameParameterData TypeRequiredDescription
AccessTokenformstringYes
ScopeformstringYes
TokenTypeformstringYes
ExpiresInformintNo
HttpStatusCodeformintNo
HttpErrorReasonformstringYes
ErrorformstringYes

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
}