Admin Map Tokens (v1)
The Map Tokens API provides access to create, read and update map token resources. Map Tokens are resources that define authentication information to external mapping systems. Typically, Atrius uses the ArcGIS Online mapping system for rendering and serving out map tiles for a floor. If a map service is "secured" on ArcGIS Online, then the authentication information for that service must be stored as a map token and then associated with the floor.
Once the map token authentication information is stored in this system, a new token will be generated for each request for a map token. The Atrius system will proxy through to ArcGIS Online to request a new token using the authentication information stored in this resource.
PutMapTokens
Save or update a list of new or existing map token resources.
ArcGIS Online Map Token (AGOL):
AGOL authentication tokens are calculated by connecting to a third party AGOL service.
- Log into the ArcGIS Online Developer Portal as the user who will be hosting the map services.
- Create an application with a unique name referencing the atrius system.
- Copy the Client ID and Client Secret from the application into a new Map Token resource.
- Ensure the authURL for the resource is https://www.arcgis.com/sharing/rest/oauth2/token/
- Save the resource and verify the token property has been generated.
Other Token:
Other static tokens can simply be stored in the "token" property in the map token resource.
Test Route
Try itNote: When you click on the Try It button you may see the following warning message: "" You can ignore this warning message and proceed by entering appropriate values for any query parameters and required header values.
Request URL
Request headers
| string |
Environment in which to execute the request. |
|
| string |
A GUID identifier for requesting partner specific resources. |
|
| string |
String value representing userid or application name issuing the request. |
|
| (optional) | string |
Media type of the body sent to the API. |
| string |
A string identifier for authenticating subscription specific resources. |
Request body
[
{
"mapTokenID": 1,
"organization_ID": 1,
"authType": "agol",
"authKey": "f2f591dcea8345ac8e9af5c9e3757618",
"authToken": "cb3793c4272243fdaab1169d2228e442243fdaab1169d2228e4493c4272243fdaab1d2228e448",
"authTimeout": 60,
"authURL": "https://www.arcgis.com/sharing/rest/oauth2/token/"
},
{
"organization_ID": 1,
"authType": "agol",
"authKey": "f2f591dcea8345ac8e9af5c9e3757618",
"authToken": "cb3793c4272243fdaab1169d2228e442243fdaab1169d2228e4493c4272243fdaab1d2228e448",
"authTimeout": 60,
"authURL": "https://www.arcgis.com/sharing/rest/oauth2/token/"
}
]{
"type": "array",
"items": {
"type": "object",
"properties": {
"mapTokenID": {
"format": "int32",
"description": "A unique numerical identifier of the map token resource",
"type": "integer"
},
"organization_ID": {
"format": "int32",
"description": "A numerical identifier that associates a map token to an organization resource",
"type": "integer"
},
"authType": {
"description": "Map Token authentication type (agol, )",
"type": "string"
},
"authKey": {
"description": "OAUTH application authentication key to third party system",
"type": "string"
},
"authToken": {
"description": "OAUTH application authentication token to third party system",
"type": "string"
},
"authTimeout": {
"format": "int32",
"description": "Time in seconds to request authentication timeout",
"type": "integer"
},
"authURL": {
"description": "URL to third party authentication system",
"type": "string"
},
"token": {
"description": "Cached authentication token",
"type": "string"
},
"token_Expire_Date": {
"format": "date-time",
"description": "Expire date of cached token",
"type": "string"
}
},
"example": {
"mapTokenID": 1,
"organization_ID": 1,
"authType": "agol",
"authKey": "f2f591dcea8345ac8e9af5c9e3757618",
"authToken": "cb3793c4272243fdaab1169d2228e442243fdaab1169d2228e4493c4272243fdaab1d2228e448",
"authTimeout": 60,
"authURL": "https://www.arcgis.com/sharing/rest/oauth2/token/",
"token": "5ce9c3bf-6141ef83290e41f2b20672a6b616f469e959d9e07--d764ee0878fb05faa9db8c9fe15e1c95d4a4be19d55cd5a74bfe8c3-w..",
"token_Expire_Date": "2017-08-28T13:50:48.2739467Z"
}
},
"example": [
{
"mapTokenID": 1,
"organization_ID": 1,
"authType": "agol",
"authKey": "f2f591dcea8345ac8e9af5c9e3757618",
"authToken": "cb3793c4272243fdaab1169d2228e442243fdaab1169d2228e4493c4272243fdaab1d2228e448",
"authTimeout": 60,
"authURL": "https://www.arcgis.com/sharing/rest/oauth2/token/",
"token": "5ce9c3bf-6141ef83290e41f2b20672a6b616f469e959d9e07--d764ee0878fb05faa9db8c9fe15e1c95d4a4be19d55cd5a74bfe8c3-w..",
"token_Expire_Date": "2017-08-28T13:50:48.2739467Z"
}
]
}Response 200
Returns a collection of updated map token resources.
{
"result": [
{
"mapTokenID": 1,
"organization_ID": 1,
"authType": "agol",
"authKey": "f2f591dcea8345ac8e9af5c9e3757618",
"authToken": "cb3793c4272243fdaab1169d2228e442243fdaab1169d2228e4493c4272243fdaab1d2228e448",
"authTimeout": 60,
"authURL": "https://www.arcgis.com/sharing/rest/oauth2/token/",
"token": "5ce9c3bf-6141ef83290e41f2b20672a6b616f469e959d9e07--d764ee0878fb05faa9db8c9fe15e1c95d4a4be19d55cd5a74bfe8c3-w..",
"token_Expire_Date": "2017-08-28T13:50:48.2739467Z"
}
],
"count": 1,
"limit": null,
"offset": null
}{
"required": [
"result",
"count"
],
"type": "object",
"properties": {
"result": {
"description": "Array of Results",
"type": "array",
"items": {
"type": "object",
"properties": {
"mapTokenID": {
"format": "int32",
"description": "A unique numerical identifier of the map token resource",
"type": "integer"
},
"organization_ID": {
"format": "int32",
"description": "A numerical identifier that associates a map token to an organization resource",
"type": "integer"
},
"authType": {
"description": "Map Token authentication type (agol, )",
"type": "string"
},
"authKey": {
"description": "OAUTH application authentication key to third party system",
"type": "string"
},
"authToken": {
"description": "OAUTH application authentication token to third party system",
"type": "string"
},
"authTimeout": {
"format": "int32",
"description": "Time in seconds to request authentication timeout",
"type": "integer"
},
"authURL": {
"description": "URL to third party authentication system",
"type": "string"
},
"token": {
"description": "Cached authentication token",
"type": "string"
},
"token_Expire_Date": {
"format": "date-time",
"description": "Expire date of cached token",
"type": "string"
}
},
"example": {
"mapTokenID": 1,
"organization_ID": 1,
"authType": "agol",
"authKey": "f2f591dcea8345ac8e9af5c9e3757618",
"authToken": "cb3793c4272243fdaab1169d2228e442243fdaab1169d2228e4493c4272243fdaab1d2228e448",
"authTimeout": 60,
"authURL": "https://www.arcgis.com/sharing/rest/oauth2/token/",
"token": "5ce9c3bf-6141ef83290e41f2b20672a6b616f469e959d9e07--d764ee0878fb05faa9db8c9fe15e1c95d4a4be19d55cd5a74bfe8c3-w..",
"token_Expire_Date": "2017-08-28T13:50:48.2739467Z"
}
}
},
"count": {
"format": "int32",
"description": "The number of records in the response",
"type": "integer"
},
"limit": {
"format": "int32",
"description": "The requested result limit",
"type": "integer"
},
"offset": {
"format": "int32",
"description": "The requested number of skipped results",
"type": "integer"
}
},
"example": {
"result": [
{
"mapTokenID": 1,
"organization_ID": 1,
"authType": "agol",
"authKey": "f2f591dcea8345ac8e9af5c9e3757618",
"authToken": "cb3793c4272243fdaab1169d2228e442243fdaab1169d2228e4493c4272243fdaab1d2228e448",
"authTimeout": 60,
"authURL": "https://www.arcgis.com/sharing/rest/oauth2/token/",
"token": "5ce9c3bf-6141ef83290e41f2b20672a6b616f469e959d9e07--d764ee0878fb05faa9db8c9fe15e1c95d4a4be19d55cd5a74bfe8c3-w..",
"token_Expire_Date": "2017-08-28T13:50:48.2739467Z"
}
],
"count": 1,
"limit": null,
"offset": null
}
}Response 400
Invalid Request.
{
"msg": "Improper format for call.",
"requestId": "273e4bb4-3019-42ea-8de9-f2c7853f7fdd",
"code": "BadRequest"
}{
"type": "object",
"properties": {
"msg": {
"description": "A descriptive message detailing the cause of the error",
"type": "string"
},
"requestId": {
"description": "A unique GUID identifier for the request",
"type": "string"
},
"code": {
"description": "A textual representation of the error code",
"type": "string"
}
},
"example": {
"msg": "A descriptive message detailing the cause of the error",
"requestId": "2269623a-af6a-419f-b15b-2c8391b50149",
"code": "ErrorCode"
}
}Response 401
Not Authorized To Access This Resource.
{
"msg": "Unauthorized to access this resource.",
"requestId": "2269623a-af6a-419f-b15b-2c8391b50149",
"code": "Unauthorized"
}{
"type": "object",
"properties": {
"msg": {
"description": "A descriptive message detailing the cause of the error",
"type": "string"
},
"requestId": {
"description": "A unique GUID identifier for the request",
"type": "string"
},
"code": {
"description": "A textual representation of the error code",
"type": "string"
}
},
"example": {
"msg": "A descriptive message detailing the cause of the error",
"requestId": "2269623a-af6a-419f-b15b-2c8391b50149",
"code": "ErrorCode"
}
}Response 404
Resource Not Found.
{
"msg": "The resource requested was not found.",
"requestId": "b9ff87b2-3397-45f7-a0b6-25482b0a7898",
"code": "NotFound"
}{
"type": "object",
"properties": {
"msg": {
"description": "A descriptive message detailing the cause of the error",
"type": "string"
},
"requestId": {
"description": "A unique GUID identifier for the request",
"type": "string"
},
"code": {
"description": "A textual representation of the error code",
"type": "string"
}
},
"example": {
"msg": "A descriptive message detailing the cause of the error",
"requestId": "2269623a-af6a-419f-b15b-2c8391b50149",
"code": "ErrorCode"
}
}Code samples
@ECHO OFF
curl -v -X PUT "https://api.us.atrius-iot.io/api/v1/admin/map-tokens/"
-H "atr-environment-id: atrdemo01us"
-H "atr-partner-id: "
-H "atr-request-source: "
-H "Content-Type: application/json"
-H "atr-subscription-key: {subscription key}"
--data-ascii "{body}"
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;
namespace CSHttpClientSample
{
static class Program
{
static void Main()
{
MakeRequest();
Console.WriteLine("Hit ENTER to exit...");
Console.ReadLine();
}
static async void MakeRequest()
{
var client = new HttpClient();
var queryString = HttpUtility.ParseQueryString(string.Empty);
// Request headers
client.DefaultRequestHeaders.Add("atr-environment-id", "atrdemo01us");
client.DefaultRequestHeaders.Add("atr-partner-id", "");
client.DefaultRequestHeaders.Add("atr-request-source", "");
client.DefaultRequestHeaders.Add("atr-subscription-key", "{subscription key}");
var uri = "https://api.us.atrius-iot.io/api/v1/admin/map-tokens/?" + queryString;
HttpResponseMessage response;
// Request body
byte[] byteData = Encoding.UTF8.GetBytes("{body}");
using (var content = new ByteArrayContent(byteData))
{
content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
response = await client.PutAsync(uri, content);
}
}
}
} // // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
public class JavaSample
{
public static void main(String[] args)
{
HttpClient httpclient = HttpClients.createDefault();
try
{
URIBuilder builder = new URIBuilder("https://api.us.atrius-iot.io/api/v1/admin/map-tokens/");
URI uri = builder.build();
HttpPut request = new HttpPut(uri);
request.setHeader("atr-environment-id", "atrdemo01us");
request.setHeader("atr-partner-id", "");
request.setHeader("atr-request-source", "");
request.setHeader("Content-Type", "application/json");
request.setHeader("atr-subscription-key", "{subscription key}");
// Request body
StringEntity reqEntity = new StringEntity("{body}");
request.setEntity(reqEntity);
HttpResponse response = httpclient.execute(request);
HttpEntity entity = response.getEntity();
if (entity != null)
{
System.out.println(EntityUtils.toString(entity));
}
}
catch (Exception e)
{
System.out.println(e.getMessage());
}
}
}
<!DOCTYPE html>
<html>
<head>
<title>JSSample</title>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>
<script type="text/javascript">
$(function() {
var params = {
// Request parameters
};
$.ajax({
url: "https://api.us.atrius-iot.io/api/v1/admin/map-tokens/?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("atr-environment-id","atrdemo01us");
xhrObj.setRequestHeader("atr-partner-id","");
xhrObj.setRequestHeader("atr-request-source","");
xhrObj.setRequestHeader("Content-Type","application/json");
xhrObj.setRequestHeader("atr-subscription-key","{subscription key}");
},
type: "PUT",
// Request body
data: "{body}",
})
.done(function(data) {
alert("success");
})
.fail(function() {
alert("error");
});
});
</script>
</body>
</html>
#import <Foundation/Foundation.h>
int main(int argc, const char * argv[])
{
NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
NSString* path = @"https://api.us.atrius-iot.io/api/v1/admin/map-tokens/";
NSArray* array = @[
// Request parameters
@"entities=true",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"PUT"];
// Request headers
[_request setValue:@"atrdemo01us" forHTTPHeaderField:@"atr-environment-id"];
[_request setValue:@"" forHTTPHeaderField:@"atr-partner-id"];
[_request setValue:@"" forHTTPHeaderField:@"atr-request-source"];
[_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
[_request setValue:@"{subscription key}" forHTTPHeaderField:@"atr-subscription-key"];
// Request body
[_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
NSURLResponse *response = nil;
NSError *error = nil;
NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];
if (nil != error)
{
NSLog(@"Error: %@", error);
}
else
{
NSError* error = nil;
NSMutableDictionary* json = nil;
NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
NSLog(@"%@", dataString);
if (nil != _connectionData)
{
json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
}
if (error || !json)
{
NSLog(@"Could not parse loaded json with error:%@", error);
}
NSLog(@"%@", json);
_connectionData = nil;
}
[pool drain];
return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';
$request = new Http_Request2('https://api.us.atrius-iot.io/api/v1/admin/map-tokens/');
$url = $request->getUrl();
$headers = array(
// Request headers
'atr-environment-id' => 'atrdemo01us',
'atr-partner-id' => '',
'atr-request-source' => '',
'Content-Type' => 'application/json',
'atr-subscription-key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_PUT);
// Request body
$request->setBody("{body}");
try
{
$response = $request->send();
echo $response->getBody();
}
catch (HttpException $ex)
{
echo $ex;
}
?>########### Python 2.7 #############
import httplib, urllib, base64
headers = {
# Request headers
'atr-environment-id': 'atrdemo01us',
'atr-partner-id': '',
'atr-request-source': '',
'Content-Type': 'application/json',
'atr-subscription-key': '{subscription key}',
}
params = urllib.urlencode({
})
try:
conn = httplib.HTTPSConnection('api.us.atrius-iot.io')
conn.request("PUT", "/api/v1/admin/map-tokens/?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64
headers = {
# Request headers
'atr-environment-id': 'atrdemo01us',
'atr-partner-id': '',
'atr-request-source': '',
'Content-Type': 'application/json',
'atr-subscription-key': '{subscription key}',
}
params = urllib.parse.urlencode({
})
try:
conn = http.client.HTTPSConnection('api.us.atrius-iot.io')
conn.request("PUT", "/api/v1/admin/map-tokens/?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################require 'net/http'
uri = URI('https://api.us.atrius-iot.io/api/v1/admin/map-tokens/')
request = Net::HTTP::Put.new(uri.request_uri)
# Request headers
request['atr-environment-id'] = 'atrdemo01us'
# Request headers
request['atr-partner-id'] = ''
# Request headers
request['atr-request-source'] = ''
# Request headers
request['Content-Type'] = 'application/json'
# Request headers
request['atr-subscription-key'] = '{subscription key}'
# Request body
request.body = "{body}"
response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
http.request(request)
end
puts response.body