{"componentChunkName":"component---src-templates-microservices-js","path":"/en/microservices/tokens/","result":{"data":{"markdownRemark":{"html":"

tokens

\n

URI

\n

http://{server}:{port}/manager/web/api/token

\n

Supported Method

\n

POST

\n

Introduction

\n

Get the token according to the account. Users can not access GIS Cloud Suite without token.

\n

Supported Interchange Format: JSON.

\n

HTTP Request Method

\n

Execute HTTP request to the URI below. In the URI below, {server} is the server of gateway, replace it by the actual gateway IP. {port} is the port of gateway, replace it by the actual gateway port.

\n

http://{server}:{port}/manager/web/api/token

\n

Post Request

\n

Users get tokens

\n

Headers Format

\n
content-type: application/json
\n

Request Params

\n

Transmit the following parameters in the body when getting token:

\n\n\t\n\t\t\n\t\t\n\t\t\n\t\n\t\n\t\t\n\t\t\n\t\t\n\t\n\t\n\t\t\n\t\t\n\t\t\n\t\n
NameTypeExpalination
userNameStringAccount username
passwordStringAccount password
\n

Response Structure

\n\n\t\n\t\n\t\n\t\t\n\t\t\n\t\n\t\n\t\t\n\t\t\n\t\n\t\n\t\t\n\t\t\n\t\n\t\n\t\t\n\t\t\n\t\n\t\n\t\t\n\t\t\n\t\n\t\n\t\t\n\t\t\n\t\n
NameExplanation
access_tokenThe token for access
refresh_tokenUsed for refresh the token when the token is expired
refresh_expires_inThe expired time of the refresh_token
token_typeThe type of token
expires_inThe expired time of the access_token
\n

Response Case

\n

Execute POST request for token resource. URL http://192.168.17.139:32507/manager/web/api/token:

\n

Headers:

\n
content-type: application/json
\n

Body:

\n
{\n  "userName":"user_admin",\n  "password":"iserver"\n}
\n

Returned response:

\n
{\n    "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJNRnpGNG9lalI2ZGJiR2xVZWYtUi1xa1M0RWF4TThJU1lOTkpNc1dROTVFIn0.eyJqdGkiOiI1ZTI3MjFmNi1iMGI1LTQ2MzYtOGRlZi1kYTE2NzEzOWVjZWYiLCJleHAiOjE1NTcxMDQyODEsIm5iZiI6MCwiaWF0IjoxNTU3MTAzOTgxLCJpc3MiOiJodHRwOi8vMTkyLjE2OC4xNy4xMzk6MzI1NDEvYXV0aC9yZWFsbXMvaXNwZWNvIiwiYXVkIjoiaXNwZWNvLWRhc2hib2FyZC1hcGkiLCJzdWIiOiJhMDk4ZTNiZS1iZGMwLTQ4ODQtOTk2NC04MWZlMjVjNTE3MmYiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJpc3BlY28tZGFzaGJvYXJkLWFwaSIsImF1dGhfdGltZSI6MCwic2Vzc2lvbl9zdGF0ZSI6ImYzNzZkZjcxLTgwOWEtNDYwOS1hOWZmLWZjZGU0NmRhNDAzYiIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsiYnVpbHRpbiIsIm9mZmxpbmVfYWNjZXNzIiwiQURNSU4iLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoiZW1haWwgcHJvZmlsZSIsImVtYWlsX3ZlcmlmaWVkIjpmYWxzZSwicHJlZmVycmVkX3VzZXJuYW1lIjoidXNlcl9hZG1pbiJ9.YWcFA4zQQMCCE_CO8qPWpRgzB1zhrFKJ5flC2mwBDJg_pJxkuye2Hd5JvxtsZwRqYcqb5ox33h2JF_kTHjIx1YmwyItOIR1Q13otUqXa3nltYCp3ixoHeC9vfNu0Dnqi55rteNnHD3ILKgaJBJLxS7n4FrZzHODHjnb4rJT6rCGt8DFRFyVE5Ibah2DX7Yo4k2vXPohOXe3zjCnx7e0tisMX7eYGn0x6sBstmqIYDDnJ9bodyGFOYoMFrA4xrOtOufuJ3uiIxtkJOGmGuDm2w_UhswgY67Yn5NqPi-gtzEYd0c2NcoIWSfX5db0zEuKYepeqE4s_HcQRAAX_ZJy9eg",\n    "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIxMWI3YjVlMy1jNWQ2LTRhYjUtOWJjYi0yMGMwNDJjODg3MWYifQ.eyJqdGkiOiJjZTAxZjM1OC1kODNiLTRhYmQtYWE5Mi02Y2I1ODQzZGQ4ZjMiLCJleHAiOjE1NTcxMDU3ODEsIm5iZiI6MCwiaWF0IjoxNTU3MTAzOTgxLCJpc3MiOiJodHRwOi8vMTkyLjE2OC4xNy4xMzk6MzI1NDEvYXV0aC9yZWFsbXMvaXNwZWNvIiwiYXVkIjoiaXNwZWNvLWRhc2hib2FyZC1hcGkiLCJzdWIiOiJhMDk4ZTNiZS1iZGMwLTQ4ODQtOTk2NC04MWZlMjVjNTE3MmYiLCJ0eXAiOiJSZWZyZXNoIiwiYXpwIjoiaXNwZWNvLWRhc2hib2FyZC1hcGkiLCJhdXRoX3RpbWUiOjAsInNlc3Npb25fc3RhdGUiOiJmMzc2ZGY3MS04MDlhLTQ2MDktYTlmZi1mY2RlNDZkYTQwM2IiLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsiYnVpbHRpbiIsIm9mZmxpbmVfYWNjZXNzIiwiQURNSU4iLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoiZW1haWwgcHJvZmlsZSJ9.vZRLjw4XaThk1i573zInoGLdJdtHGbCUxAyYu0n8uOU",\n    "refresh_expires_in": 1800,\n    "not-before-policy": 0,\n    "scope": "email profile",\n    "token_type": "bearer",\n    "session_state": "f376df71-809a-4609-a9ff-fcde46da403b",\n    "expires_in": 300\n}
\n

If the returned response you get was same as the example, you have got the token successfully, the token is the content in ‘access_token’. You can use the token to visit GIS Cloud Suite.

\n

How to use token

\n

After getting the access_token by POST request, execute the resource request, take http://{server}:{port}/manager/web/api/service/nodes as an example. There are three methods to achieve resource request, they are Authroization Header, Form-Encoded Body Parameter, and URI Query Parameter. The three methods decrement by priority.

\n
\n

Notes:
\nThe expiration time of access_token is 5 minutes. If the token was expired, used refresh_token to get the new token(the expiration time of refresh_token is 30 minutes), or reacquire the access_token.

\n
\n

Authorization Header

\n

The format of Headers:

\n

GET resource HTTP/1.1

\n
content-type: application/json\nAuthorization: Bearer {access_tokens}
\n

Example:

\n

GET http://192.168.17.139:32507/manager/web/api/service/nodes

\n
content-type: application/json\nauthorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJNRnpGNG9lalI2ZGJiR2xVZWYtUi1xa1M0RWF4TThJU1lOTkpNc1dROTVFIn0.eyJqdGkiOiI1ZTI3MjFmNi1iMGI1LTQ2MzYtOGRlZi1kYTE2NzEz\nOWVjZWYiLCJleHAiOjE1NTcxMDQyODEsIm5iZiI6MCwiaWF0IjoxNTU3MTAzOTgxLCJpc3MiOiJodHRwOi8vMTkyLjE2OC4xNy4xMzk6MzI1NDEvYXV0aC9yZWFsbXMvaXNwZWNvIiwiYXVkIjoiaXNwZWNvLWRhc2hib2FyZC1hcGkiLCJzdWIiOiJhMDk4ZTNiZS1iZGMwLTQ4ODQtOTk2NC04MWZlMjVjNTE3MmYiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJpc3BlY28tZGFzaGJvYXJkLWFwaSIsImF1dGhfdGltZSI6MCwic2Vzc2lvbl9zdGF0ZSI6ImYzNzZkZjcxLTgwOWEtNDYwOS1hOWZmLWZjZGU0NmRhNDAzYiIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsiYnVpbHRpbiIsIm9mZmxpbmVfYWNjZXNzIiwiQURNSU4iLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoiZW1haWwgcHJvZmlsZSIsImVtYWlsX3ZlcmlmaWVkIjpmYWxzZSwicHJlZmVycmVkX3VzZXJuYW1lIjoidXNlcl9hZG1pbiJ9.YWcFA4zQQMCCE_CO8qPWpRgzB1zhrFKJ5flC2mwBDJg_pJxkuye2Hd5JvxtsZwRqYcqb5ox33h2JF_kTHjIx1YmwyItOIR1Q13otUqXa3nltYCp3ixoHeC9vfNu0Dnqi55rteNnHD3ILKgaJBJLxS7n4FrZzHODHjnb4rJT6rCGt8DFRFyVE5Ibah2DX7Yo4k2vXPohOXe3zjCnx7e0tisMX7eYGn0x6sBstmqIYDDnJ9bodyGFOYoMFrA4xrOtOufuJ3uiIxtkJOGmGuDm2w_UhswgY67Yn5NqPi-gtzEYd0c2NcoIWSfX5db0zEuKYepeqE4s_HcQRAAX_ZJy9eg
\n

The returned response in json format:

\n
[\n    {\n      "nodeName": "Node",\n      "nodeType": null,\n      "featureIds": null,\n      "instanceNumber": 0,\n      "serviceInfos": [\n        {\n          "componentName": "map-China400-d3awywrtby",\n          "interfaceName": "rest",\n          "name": "Instance-map-China400-d3awywrtby-rest",\n          "providerName": "Provider-map-China400-d3awywrtby",\n          "dataSourceType": "workspace",\n          "serviceType": "map-rest"\n        }\n      ],\n      "available": true\n    }\n]
\n

Form-Encoded Body Parameter

\n

Use this method when the client does not support the method Authorization Header.

\n

The format of Headers:

\n

POST {resource} HTTP/1.1

\n
content-type: application/x-www-form-urlencoded
\n

The format of Body:

\n
access_token={access_token}
\n
\n

Notes:
\nForm-Encoded Body Parameter does not support GET request, the request body must follow the application/x-www-form-urlencoded coding, separate the parameters by symbol ’&‘.

\n
\n

URI Query Parameter

\n

Use this method when both of Authorization Header and Form-Encoded Body Parameter could not request.

\n

The format of Headers:

\n

GET {resource}?access_token={access_token} HTTP/1.1

\n
Cache-Control: no-store
\n

Example:

\n

Get http://192.168.17.139:32507/manager/web/api/service/nodes?access_token=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJNRnpGNG9lalI2ZGJiR2xVZWYtUi1xa1M0RWF4TThJU1lOTkpNc1dROTVFIn0.eyJqdGkiOiI1ZTI3MjFmNi1iMGI1LTQ2MzYtOGRlZi1kYTE2NzEzOWVjZWYiLCJleHAiOjE1NTcxMDQyODEsIm5iZiI6MCwiaWF0IjoxNTU3MTAzOTgxLCJpc3MiOiJodHRwOi8vMTkyLjE2OC4xNy4xMzk6MzI1NDEvYXV0aC9yZWFsbXMvaXNwZWNvIiwiYXVkIjoiaXNwZWNvLWRhc2hib2FyZC1hcGkiLCJzdWIiOiJhMDk4ZTNiZS1iZGMwLTQ4ODQtOTk2NC04MWZlMjVjNTE3MmYiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJpc3BlY28tZGFzaGJvYXJkLWFwaSIsImF1dGhfdGltZSI6MCwic2Vzc2lvbl9zdGF0ZSI6ImYzNzZkZjcxLTgwOWEtNDYwOS1hOWZmLWZjZGU0NmRhNDAzYiIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsiYnVpbHRpbiIsIm9mZmxpbmVfYWNjZXNzIiwiQURNSU4iLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoiZW1haWwgcHJvZmlsZSIsImVtYWlsX3ZlcmlmaWVkIjpmYWxzZSwicHJlZmVycmVkX3VzZXJuYW1lIjoidXNlcl9hZG1pbiJ9.YWcFA4zQQMCCE_CO8qPWpRgzB1zhrFKJ5flC2mwBDJg_pJxkuye2Hd5JvxtsZwRqYcqb5ox33h2JF_kTHjIx1YmwyItOIR1Q13otUqXa3nltYCp3ixoHeC9vfNu0Dnqi55rteNnHD3ILKgaJBJLxS7n4FrZzHODHjnb4rJT6rCGt8DFRFyVE5Ibah2DX7Yo4k2vXPohOXe3zjCnx7e0tisMX7eYGn0x6sBstmqIYDDnJ9bodyGFOYoMFrA4xrOtOufuJ3uiIxtkJOGmGuDm2w_UhswgY67Yn5NqPi-gtzEYd0c2NcoIWSfX5db0zEuKYepeqE4s_HcQRAAX_ZJy9eg

\n
Cache-Control: no-store
\n

The returned rensponse in json format:

\n
[\n    {\n      "nodeName": "Node",\n      "nodeType": null,\n      "featureIds": null,\n      "instanceNumber": 0,\n      "serviceInfos": [\n        {\n          "componentName": "map-China400-d3awywrtby",\n          "interfaceName": "rest",\n          "name": "Instance-map-China400-d3awywrtby-rest",\n          "providerName": "Provider-map-China400-d3awywrtby",\n          "dataSourceType": "workspace",\n          "serviceType": "map-rest"\n        }\n      ],\n      "available": true\n    }\n]
","frontmatter":{"title":"GIS Cloud Suite","next":null,"prev":null},"fields":{"path":"content/microservices/tokens.en.md","slug":"/en/microservices/tokens/","langKey":"en"}}},"pageContext":{"slug":"/en/microservices/tokens/"}}}