API Keys

Request OTP

post/{dataset}/v1/ApiKeys/otp/request

Requests one-time password used to generate API Key. OTP has limited expiration frame and is created for existing email address.

Request

dataset

required

string

Existing Prospector user's email address

email

required

string <email>

Responses

200

Success

Request samples

{"email": "user@example.com"
}

post/{dataset}/v1/ApiKeys/otp

Verifies one-time password. If OTP is valid, returns new API key.

Request

dataset

required

string

OTP token and expiryDate of newly generated API key

token	string or null
expiresAt	string or null <date-time>

Responses

200

Success

Request samples

{"token": "string",
"expiresAt": "2019-08-24T14:15:22Z"
}

Response samples

application/json

{"data": {"apiKey": "string",
"expiresAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z"
}
}