API Keys

Follow

API keys give code-level access for Dynamic Yield APIs. Available permissions include:

  • Personalization API: To create and manage API-based experiences, including actions related to choosing a variation and reporting data. 
  • Feed: To manage a product feed using APIs.

Create an API key

Note: To ensure that API Keys are used responsibly, only teammates with Admin permissions on the site can create and edit API keys. Teammates with Editor permissions can view API keys, but cannot create or delete them. Teammates with Viewer permissions will not be able to see the API Keys page at all.  

  1. Go to Settings › API Keys and click New Key.
  2. Enter a name, and internal notes (optional).
  3. Choose between a server-side and a client-side key. Each type can only be used with its designated endpoint (see Basic Concepts).
  4. In the ACL section, select one or more permissions for the key. Different options appear based on your site's vertical or features that were enabled on your site.
  5. Click Save.
    api_key_server_side.png

You can now click Copy to get the key in plain text. The key should be passed as an HTTP header with any API call you make. For example:

PUT /v2/feeds/dyid/666532575846065165 HTTP/1.1
DY-API-Key: baadc6ba740a352c9106dc7857a7eb9c
Content-Type: application/json 
{// JSON-formatted request body...}
POST /v2/serve/user/choose
DY-API-Key: baadc6ba740a352c9106dc7857a7eb9c 
Content-Type: application/json
{// JSON-formatted request body...}

Deleting an API key

Deleting an API key is irreversible, and any APIs referring to a deleted key must be modified to use a new key.

  1. Go to Settings › API Keys.
  2. Hover over the key you want to delete and click the trash icon icon_Trash.png. The key is deleted within a few minutes.