Skip to main content

Api Key

Get your API key​

Standard workflow to get your API key.

Step 1: DQCO-OP account​

  • First you need to have valid credentials for your Data Quality Account.
  • If you don't have one, sign up to create an account.

Step 2: Get your access token​

  • Use the /login swagger endpoint to obtain you token.
  • Input your username and password, then execute the endpoint 
    {
      "username": "Your_Email",
      "password": "Your_Password"
    }
  • The response from the endpoint will contain the token. Copy your token value. It will look similar to the following:: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXN0b21lcklkIjoiNCIsImlhdCI6MTc0MTU3ODI2NSwiZXhwIjoxNzQxNTg1NDY1fQ.h8Gpa1JTU9YRJWjQDisrPuyELC0kE3_65nj1FCxlXhY 
    {
      "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXN0b21lcklkIjoiNCIsImlhdCI6MTc0MTU3ODI2NSwiZXhwIjoxNzQxNTg1NDY1fQ.h8Gpa1JTU9YRJWjQDisrPuyELC0kE3_65nj1FCxlXhY",
      "refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXN0b21lcklkIjoiNCIsImlhdCI6MTc0MTU3ODI2NSwiZXhwIjoxNzQxNjA3MDY1fQ.7eUgXCbsfWja301uirlsHaXIQkN5WIcFnWXtBBIKLCU"
    }

Step 3: Get your API key​

  • Use the GET /tools/key swagger endpoint to retrieve your API key.
    1. In the Authorization section, select Bearer Token.
    2. Paste the token you copied in the Value field.
    3. Execute the request.
    4. The response from the endpoint will contain your API key. 
      {
        "API key": "00dcdfb4edd24de0ef7af4cb7d7a30dc30a27a65"
      }
    5. Copy the API key.
    6. If you did not receive an API key after following the previous steps, you may need to read the following section.

No API key or invalidate current API key​

Be cautious:

This endpoint generates a new API key, immediately invalidating the previous one — any surveys still using the old key will lose access to the quality tools. To avoid disruptions, always run GET /tools/key before executing this endpoint.

  • Follow steps 1 and 2 from above section
  • Use the POST /tools/key swagger endpoint to get your API key.
    1. In the Authorization section, select Bearer Token.
    2. Paste the token you copied in the Value field.
    3. Execute the request.
    4. The response from the endpoint will contain your API key. 
      {
        "API key": "00dcdfb4edd24de0ef7af4cb7d7a30dc30a27365"
      }
    5. Copy the API key.
    6. In the future, simply execute the GET /tools/key endpoint to retrieve this API key.