Skip to main content

API keys

Every call to the Quality Tools carries an API key. You create and manage keys in the DQCO-OP dashboard.

Create a key​

Step 1: Your DQCO-OP account​

You need a Data Quality Co-op account. If you don't have one, sign up.

Step 2: Open the API keys page​

Log in to the dashboard and go to Settings, then API keys. The page has three tabs: General, Public and Private. Keys you created before key types existed are on the General tab and keep working exactly as before.

Step 3: Create the key​

  • Select the tab for the key type you want and click Create general key, Create public key or Create private key. Not sure which? See Key types.
  • Give it a name of 3 to 50 characters that you'll recognise later, such as the platform or environment it's for.
  • General and public keys appear in the list with a copy button, so you can copy them at any time.
  • A private key is shown once, in the "Copy your private key" dialog. Copy it and store it on your server before you close the dialog. Afterwards the list shows only its last 4 characters.

Manage your keys​

  • Create as many keys as you need, for example one per platform or environment. Creating a key never changes your other keys.
  • Deactivate a key from its row menu, and reactivate it later. A reactivated key keeps the same value. What a deactivated key returns is on Deactivated Key.
  • The list shows each key's status, when it was last used (to the minute) and when it was created.
  • A key listed with the type Unknown can only be deactivated. Create a new key to replace it.
  • A public key's row menu also turns server-only results on or off.
  • Keys can only be created, listed, deactivated and reactivated from the dashboard. API keys can't manage keys.

Next steps​

  • Key types: choose the right key for your integration.