GetJWT

Get a JWT token to authenticate requests to our services

To connect to this service you'll need to use one of these endpoints:

JSON

Open API

SOAP

Description

This method generates a JWT token with an expiry date and credit limit. The names of services should also be passed to the method for further restriction.

Parameters

The following parameters can be supplied to this method

username	username The username to authenticate as. This is the same as the username you use to log into this website. Please note that the other standard authentication methods are not available for this method - username authentication is required.
password	password The password to authenticate with. This is the same as the password you use to log into this website.
clientIp	clientIp The IP address of the client. This can be null
expiresAt	expiresAt A DateTime at which the JWT Token will expire
allowedMethods	allowedMethods A string array of service names
maxCredits	maxCredits An optional parameter containing a limit for the number of credits the token can use.

Advanced Options

The following options can be specified as part of the option parameter. Each option is specified as a key/value pair. The list of available names is shown below, along with a description of the allowable values for that name.

Common Options
Name	Description
ApplicationName	ApplicationName Gives the name of the calling application - used to break down usage by application in the usage reports on the dashboard

Results

This method returns an object containing the following fields:

Status

Status	Status Indicates whether the method call was successful, or if some error occurred. If the `Success` field is `true`, the other results described below can be used to get the results of the method. If `Success` is `false`, some error occurred in calling the method, such as the authentication failed or the account is out of credits. The details of the error can be obtained from the `ErrorMessage` field, and any other results should be ignored
Jwt	Jwt The Token string generated from the request

Status

Indicates whether the method call was successful, or if some error occurred. If the Success field is true, the other results described below can be used to get the results of the method. If Success is false, some error occurred in calling the method, such as the authentication failed or the account is out of credits. The details of the error can be obtained from the ErrorMessage field, and any other results should be ignored

Jwt

Jwt

The Token string generated from the request