Documentation

Unblu 6 (latest)

Your API key is the link between the snippet and your account. The API key must be included within the code of the snippet so that the collaboration server can check that the account is valid.

Here you can edit information associated with a key or select New APIKey if you need new keys. Adding a name and a description to each key can be useful if you use multiple API keys either for testing or for implementing different configurations. By adding a name and some descriptive text you will be able to more easily manage the snippet-APIKEY-server associations. For example, you might want to use the Description field to record which web pages or domains or named areas any given key is associated with.

Before adding names and descriptions though, we should look at the snippet to find out how to associate an API key with a server.

  1. In the Agent Desk, from the main menu select API keys. This page contains your API keys.

    account 4
  2. In the APIKeys page select the (account 7) icon. This takes you directly to the code snippet.

    account api keys javascript snippet

    The line with a blue background in the image above shows where to place the API key and the location and name of the associated server. (The server information goes inside the double quotation marks (" ").)

    The first line (comment) in the code above has a version number. This is the version number associated with the snippet, not the underlying Unblu product version.

To create a new API key:

  1. From the main menu select APIKeys.

  2. Click the New APIKey button. A modal window slides in from the right telling you that a new API key will be created on the server.

    account 5
  3. Add a name and a description for the new API key then click the Save button to create the new API key. The modal page disappears and the new API key is generated automatically and added to your account.

    account 6
If you delete a key an 'undo' dialog displays. This gives you a chance to undo an accidental deletion.