Definition
This GET API is used to fetch the details of your account (such as email id, name, account type, logo, white label info, compliance info and candidate registration fields).
*PDF documentation reference - Section 2.1 Fetch Mettl Account Information
Query Parameters
In our REST APIs, Query Parameters have to be URL encoded as the data is being transmitted in the request URL. This is especially important for the asgn parameter and any parameters with JSON as they always contain characters that need to be URL encoded. Since ak and ts parameters don't contain any characters that need to be URL encoded, URL encoding of these parameters can be skipped.
Mandatory parameters
|
|
| ak |
This is your Public-API-Key, which Mettl uses to identify your account.
|
| ts |
This is the current UNIX or Epoch Timestamp (the number of seconds between 1970-01-01 00:00:00 and current UTC Time). Any current generated Timestamp will be valid for 24 hours only.
|
| asgn |
This is a unique Signature which has to be generated for each API request.
The Signature is generated by creating a String-to-Sign and hashing it with your Private-API-Key using the HMAC-SHA256 (for version v2 and v3) or HMAC-SHA1 (for v1) hashing algorithm with Base-64 and URL encoding.
|
Example
Request without Signature
a. GET request URL, with queries ak and ts but without asgn (Signature)
b. Creating a String-to-Sign, calculated with Method + Endpoint + Values of query parameters, in new lines and in ascending order of the parameter name (i.e., the new line characters "\n" followed by values of ak and ts in order, for this example)
c. Output of the Sting-to-Sign created above
ab12c345-6789-0123-456d-78e9f0123456
1635976200
d. Private-API-Key to sign/hash the above Sting-to-Sign using HMAC-SHA256 (since API version is v2)
zy98x765-4321-0987-654w-32v1u0987654
e. Output of the generated Signature for asgn using the Sting-to-Sign and your Private-API-Key, hashed with HMAC-SHA256 (Base-64 and URL Encoded)
v4%2BlYYoZTdoeFV9XSTehS1MLRpBmjTRqQqKGizlHIN8%3D
Request with Signature
f. Final GET request URL with queries ak , ts and asgn (URL Encoded)