get_keys

To receive information about the keys used to access external cartographic services, use the user/get_keys command.

Copied!
svc=user/get_keys&params={}

Response

If the request has been completed successfully, the following response is returned:

Copied!
{
	"<key_name>": {
		"ct":<long>,                    /* creation time */
		"name":<text>,                  /* key name */
		"key":<text>,                   /* key value (may be concealed depending on the user, provider and key type) */
		"provider":<text>,              /* map provider name ("google", "here", "trimble", etc.) */
		"type":<uint>,                  /* bit-wise combination of values from the "Key types" table (see below) */
		"sites":[<text>,<text>,<text>]  /* identifiers of sites for which the key is available */
	}
	...
}

Key types

ValueName
1GIS_EXT_MAP_KEY_PROTECTED
2GIS_EXT_MAP_KEY_ROUTING
4GIS_EXT_MAP_KEY_GEOCODING
8GIS_EXT_MAP_KEY_DISTANCE_MATRIX
16GIS_EXT_MAP_KEY_PUBLIC
32GIS_EXT_MAP_KEY_SPEEDINGS

If the request hasn’t beed completed, an error code is returned.

Error codes

Error codeDescription
1Invalid or obsolete request SID.
4Invalid request parameters.
6Internal server error.
7Unauthorized user.
Download PDF file
Download Word document

See also