Tools

Learn how to communicate with the API

To send a request to the GoodData.CN API, you can use any of the following tools:

While you can use CURL for simple use-cases, we recommended using more advanced tools to communicate with the Gooddata.CN API. We suggest tools that are capable of generating API requests and payloads using the OpenAPI schema .

Postman

Use the following steps to configure Postman for use with GoodData.CN

  1. Install Postman.
  2. Select Import > Link.
  3. Copy and paste the URL of the GoodData.CN raw OpenAPI schema into the Enter a URL field.
    Postman initial window
  4. Select Continue.
  5. Select Show advanced settings and set Folder Organization to Tags.
  6. Select Import.
    Postman import OpenAPI schema
  7. Select Collections and then select the OpenAPI definition for GoodData.CN.
  8. In the Authorization tab, select Type and choose Bearer Token.
  9. Insert your API Token into the Token field.
    Postman authentication setup
  10. In the Variables1 tab, set the baseUrl to the hostname for your organization.
    Postman variables setup
  11. Save your configuration.
  12. Select an endpoint and try to send a request.

Generate your own client

  1. Download the GoodData.CN OpenAPI schema .
  2. Generate the client in the language of your choice with https://openapi-generator.tech. 2

Example

The following example generates a TypeScript client into the current folder:

openapi-generator generate -i https://www.gooddata.com/developers/cloud-native/doc/latest/api/gooddata-cn-oapi-all-raw-schema.json -g typescript-rxjs -o .

  1. More about Postman variables: https://learning.postman.com/docs/sending-requests/variables/#accessing-variables ↩︎

  2. Note that in some languages, the code generated from openapi-generator might not be valid. You must update it manually. Java/Kotlin: https://github.com/OpenAPITools/openapi-generator/issues/634 / https://github.com/OpenAPITools/openapi-generator/issues/5903 / https://github.com/OpenAPITools/openapi-generator/issues/2892. Python: https://github.com/OpenAPITools/openapi-generator/issues/8892 ↩︎