POST /application
This service is for registering an application in our system and returning an application token and an expiration date until which the token is valid. The token can then be used for application authentication.
On success, the HTTP status code in the response is 200 OK
If there is already an application name associated with the same mail that you are sending, you will receive a 409 Conflict.
Resource URL​
https://api.volo-access.com/v1/config/application
Resource Information​
Input Parameters​
This service consumes a JSON object called ApplicationRegistrationForm and it is mandatory that you send it. It contains the information required for registering an application in our system:
| Parameter name | Type | Description |
|---|---|---|
| applicationName | String | The name of the application. It can't be null and exceed 250 characters |
| applicationEmail | String | The application email. It can't be null and needs to assume an email structure "someone@domain" |
Output​
This service produces a JSON object, called LoginResponse with the following structure:
| Parameter name | Type | Description |
|---|---|---|
| applicationName | String | The name of the application you've registered. |
| applicationEmail | String | The email of the application you've registered |
| applicationToken | String | The token that is associated with your application and that will be used to authenticate requests |
| expirationDate | Date | The date in which the token expires |
| numberOfConnections | Integer | The number of simultaneous connections the registered application can have with our system |
Example Request​
POST /restapiproxy-env.com/v1/config/application HTTP/1.1
Content-Type: application/json
{
"applicationEmail":"test@gendis.co.uk",
"applicationName":"Test Application"
}
Example Response (Success)​
HTTP/1.1 200 OK
{
"applicationEmail":"test@gendis.co.uk",
"applicationName":"Test Application",
"applicationToken":"d1d0ecac-3cca-48ef-a4c3-83005c6376ca",
"expirationDate":"2017-01-26T11:59:03.477Z",
"numberOfConnections":10
}
Example Response (Conflict)​
HTTP/1.1 409 Conflict
{
"applicationMessage":"The request could not be completed due to a conflict with the current state of the resource",
"consumerMessage":"An application already exists with that name and email."
}