Getting API Keys via the Personal Account

Description of the Situation

The SmartPlayer platform has added a feature that allows users to request an API key for integration through the personal account. This page explains how to correctly use this solution.

To create an API key, the user must have the “Administrator” role.

Action Algorithm

To request an API key, the user must log in or register on the SmartPlayer platform.
Next, the user should scroll down the main page and go to the “Settings” section.

Example of the “Settings” section in the personal account

In the “Settings” section, the user must also scroll down and find the “For Developers” category and click on it.

Example of the “For Developers” category display

In the expanded window, the user needs to click the “Open” button in the upper left part of the screen to open the page with parameters for creating an API key.

Example of the “Open” button

API Key Creation Page

After opening the new page, the user will see a table with fields and two buttons: “Delete all keys” and “Create key” in the upper right corner.

Example of the API key creation page

The API key creation page includes the following elements:

• “Delete all keys” button — allows you to delete all created API keys at once. To complete the process, confirmation in a modal window is required;
• “Create key” button — opens the modal window for API key creation. To complete the process, fields must be filled and the key created;
• Selection checkbox — allows multiple API keys to be selected for batch actions;
• Key name — the field where the key's name is displayed;
• Key — the field where the user can see the last 4 characters of the API key;
• Creation date — the field displaying the API key creation date;
• Expiration date — the field displaying the date after which the API key becomes invalid;
• Last used — the field displaying the date the API key was last used for connection;
• “Delete” icon (trash can) — button to delete selected API keys.

Example of the page with filled-in fields

Creating an API Key

After clicking the “Create key” button, the user will see a modal window.

Example of the modal window for API key creation

In the window, the user must:

1. Come up with a name for the API key.
2. Select its expiration date using the calendar.

Example of filling out API key creation parameters

Then the user must copy the key using the special icon (highlighted in the screenshot) and check the “I have copied the key” box. This step is mandatory to complete the process — otherwise the system will not allow further actions.

Example of the API key creation process

It is recommended to read the description of the created key.

Example of a note display

Feature Details

This feature includes a set of specific characteristics:

• It is not allowed to use the same name for multiple API keys;
• The lifespan of one API key is 1 year;
• Each created API key is unique;
• After creating an API key, it must be copied. If the user does not copy the key and leaves the API key creation page, it will no longer be possible to retrieve or copy it;
• The API key inherits and passes along the set of permissions of the user who created it.

Video Tutorial

Getting API Keys via the Personal Account

Additional Information

If this article does not help you use the feature as intended or you still have questions after reading it, you can ask them in the “Discussions” section at the top of the page.

Example of the “Discussions” tab on a wiki page

You can also find more information on the page Как взаимодействовать пользователю с разделом "Обсуждения"