Authentication
This API authenticates users' credentials (email and password) as a POST request body to generate an access token. The token is not required for the map services.
Each token is valid for 3 days. Its expiry timestamp is in UNIX format. When it expires, the user needs to re-authenticate with the same credentials. The token does not auto renew when it expires.
Developers are strongly encourage to securely store sensitive data such as API keys and passwords in your application. Do not pass the authentication data in plain text.
BODY PARAMETERS
Registered email used for OneMap registration
Password used for OneMap registration
Sample Request (USING THE DOTENV IN NODE.JS AS FOR ILLUSTRATION PURPOSE)
1const url = "https://www.onemap.gov.sg//api/auth/post/getToken";
2
3 // Prepare the data payload
4 const data = JSON.stringify({
5 email: process.env.ONEMAP_EMAIL,
6 password: process.env.ONEMAP_EMAIL_PASSWORD
7 });
8
9 fetch(url, {
10 method: 'POST',
11 headers: {
12 'Content-Type': 'application/json',
13 },
14 body: data,
15 })
16 .then(response => {
17 if (!response.ok) {
18 throw new Error(`HTTP error! Status: ${response.status}`);
19 }
20 return response.json(); // Parse response as JSON
21 })
22 .then(data => {
23 console.log(data); // Log the response data to the console
24 })
25 .catch(error => {
26 console.error('Error:', error); // Log any errors
27 });
28 Sample Response
1{
2 "access_token": "***********************",
3 "expiry_timestamp": "1689388144"
4}Possible Error Responses
401 - Authentication failed, please contact admin at support@onemap.gov.sg
404 - User is not registered in system.
404 - You have to enter a valid email address and valid password to generate a token.
