Acquire an API key

This is an API function to acquire an API Key. This API function corresponds to the operation on the Log In screen of Manager.

Format
curl -X POST --header 'Content-Type: application/json'
             --header 'Accept: application/json'
             -d 'REQUESTBODYINJSONFORMAT'
             'http://HOSTNAME:PORTNUMBER/api/v1/login'
Request body (JSON format)
{
  "userName": "string",
  "password": "string"
}
Request parameter (JSON format)
Item name Request parameter Type Value Default value
User Name userName String

Maximum 64 characters

 Impossible to omit
Password password String Maximum 64 characters Impossible to omit
Response
{
   "apiKey": "string",
   "expiresOn": 0,
   "userId": "string",
   "clientSecret" : "string"
}
Response parameter
Item name Response parameter Type Value
API Key apiKey String The key that will be specified in the API request header is returned.
Term of API Key expiresOn Integer

The epoch is returned by using a unit of milliseconds.

(The number of milliseconds that has accumulated since midnight of 1970/1/1)

Example: 1517107653277
User ID userId String  
Reissue Key clientSecret String

You can reissue an API key by using this key for the input of the Reacquire API Key API function without using a user name and a password.