Upload Access Tokens for Geo Charts
Geo charts (Pushpins) use a map provider as a source for maps visualizations. A special map provider access token is required to enable the geo charts in Analytical Designer.
GoodData Cloud users are provided with access tokens automatically and do not have to worry about the token validity. However, they can also upload their own access tokens for an organization or workspace as well.
Upload Your Access Token
You can upload the map access token by:
- Updating the helm chart for all organizations, or
- Via API for a whole organization or individual workspaces.
Token expiration
Verify regularly that your access token is valid. If your token expires, upload a new token.
Organizations
To upload the access token for organizations, use the following API call:
curl $HOST_URL/api/v1/entities/organizationSettings \
-H "Content-Type: application/vnd.gooddata.api+json" \
-H "Accept: application/vnd.gooddata.api+json" \
-H "Authorization: Bearer $API_TOKEN" \
-X POST \
-d '{
"data": {
"attributes": {
"content": {
"value": "<map_access_token_value>"
},
"type": "MAP_TOKEN"
},
"id": "<some_id>",
"type": "organizationSetting"
}
}'|jq .Invoke-RestMethod -Method Post -Uri "$HOST_URL/api/v1/entities/organizationSettings"`
-ContentType "application/vnd.gooddata.api+json" `
-H @{
'Accept' = "application/vnd.gooddata.api+json"
'Authorization' = "Bearer $API_TOKEN"
} `
-Body '{
"data": {
"attributes": {
"content": {
"value": "<map_access_token_value>"
},
"type": "MAP_TOKEN"
},
"id": "<some_id>",
"type": "organizationSetting"
}
}' | ConvertTo-JsonOnly available with GoodData.CN
If you add the access token to the helm chart on the deployment level, all organizations will automatically share this token.
Add the
GDCN_SETTING_MAP_TOKENvalue to themetadataApi.extraEnvVarsin your helm chart options.metadataApi: extraEnvVars: - name: GDCN_SETTING_MAP_TOKEN value: '{"value": "<map_access_token_value>"}'Upgrade your helm chart.
helm upgrade
Your token is uploaded and you can start using geo charts.
Workspaces
To upload the access token for individual workspaces, use the following API call:
curl $HOST_URL/api/v1/entities/workspaces/$WORKSPACE_ID/workspaceSettings \
-H "Content-Type: application/vnd.gooddata.api+json" \
-H "Accept: application/vnd.gooddata.api+json" \
-H "Authorization: Bearer $API_TOKEN" \
-X POST \
-d '{
"data": {
"attributes": {
"content": {
"value": "<map_access_token_value>"
},
"type": "MAP_TOKEN"
},
"id": "<some_id>",
"type": "workspaceSetting"
}
}'|jq .Invoke-RestMethod -Method Post -Uri "$HOST_URL/api/v1/entities/workspaces/$WORKSPACE_ID/workspaceSettings"`
-ContentType "application/vnd.gooddata.api+json" `
-H @{
'Accept' = "application/vnd.gooddata.api+json"
'Authorization' = "Bearer $API_TOKEN"
} `
-Body '{
"data": {
"attributes": {
"content": {
"value": "<map_access_token_value>"
},
"type": "MAP_TOKEN"
},
"id": "<some_id>",
"type": "workspaceSetting"
}
}' | ConvertTo-Json