March 24, 2018

LAST REMINDER: Add Mandatory User-Agent Header to API Request

Starting from April 7, 2018, the GoodData REST API will require every API request to contain the User-Agent header. Any API request without the User-Agent header made after April 7, 2018, will be rejected.
Please note that the date was moved from March 31, 2018, to April 7, 2018.

What is the purpose of the header?
The User-Agent header helps us identify users of our API and what they use the API for.

What is the header format?
We recommend that you set the User-Agent header in one of the following formats:

  • {product}-{task}/{version} ({your_email@example.com})
    or
  • {company}-{task}/{version}

where:
-- {product} is the product in whose context you use the API (it can be your company's product that you are responsible for).
-- {task} is the business domain in which you use the API (for example, managing users, configuring white-label properties, or creating projects).
-- {company} is your company name.
-- {version} is the version of your API integration. If you are not sure what version to include, set it to 1.0.
-- {your_email@example.com} is your email or the email of the contact person responsible for the product in your company.

Do not use spaces or slashes ( / ) in the User-Agent header apart from those that are already specified by the format.

How can you construct the User-Agent header?
Use the following examples to understand how to set the header:

  • John Roe works in a company called 'Acme Corporation', on a product called 'Insight'. He uses the GoodData API to orchestrate ETL graphs across projects in his department. Here is how John can set the User-Agent header:
    AcmeCorporation-ETLOrchestrator/1.0
    Insight/1.0 (john.roe@acme.com)
  • Jane Doe works in a company called 'Initech'. She uses the GoodData API to perform general administrative tasks across multiple products. Here is how Jane can set the User-Agent header:
    Initech-AdminTools/1.0

Action needed!
If you use a tool for handling API calls or a custom library for integrating with the GoodData REST API, update them to include the User-Agent header in every API request.

TIP: Set up one User-Agent header per tool/custom library and per task. For example, if you are using one tool to perform many administrative tasks, use a general header of AdminTools. However, if you are using a few tools or libraries or if you are performing tasks from different business areas (for instance, managing access to dashboards and adding users to a Data Warehouse instance), set up headers for each tool or for each task separately.

When is the deadline for implementing the User-Agent header? 
The date is April 7, 2018. However, we strongly recommend that you do so as soon as possible.

Are CloudConnect users affected?
No. If you call the API from CloudConnect (for example, REST Connector or HTTP Connector), you do not have to specify the User-Agent header. CloudConnect provides a default User-Agent header for all API calls that these components make.

If you have any question, please contact GoodData Support.

 

highlightColor: New White-Label Setting

We have introduced a new white-label setting, highlightColor.
Using this parameter, you can set the color of a highlighted or selected element (link, button, selected item in a dropdown, and so on) on a dashboard in the Dashboards section.

NOTE: This parameter is valid only when you have the new look-and-feel of the Dashboards section enabled. For more information, see 'Dashboard UI Visual Refresh' in Platform Settings.

Default (blue):
02.png   03.png

Customized (red):
01.png

TIP: Set the highlightColor parameter to a color that has enough contrast to be clearly visible on the white dashboard background. Avoid setting this parameter to colors that are too light.

Learn more:
Customize the White-Labeled Domain
API: White-Labeling

 

New API - LcmEntities

A new API endpoint allows you to return a list of all LCM entities including: project_id, project title, dataproduct, segment, client and links to all those entities. This can be used for to show all accessible projects for a specific data product.

Learn more:
GoodData API

Have more questions? Submit a request

Comments

Powered by Zendesk