Управление на API ключове
Страницата API Keys ви позволява да създавате, преглеждате и управлявате ключовете, които вашите приложения използват за извикване на FourA API.
Преглед на вашите ключове
Страницата показва всички ключове, до които имате достъп:
- Лични ключове, които сте създали директно.
- Ключове на организация, ако сте собственик или администратор на организацията.
- Ключове на екип, споделени с вас чрез членство в екип.
Всеки ред в таблицата показва:
| Колона | Какво показва |
|---|---|
| Име | Показвано име и (незадължително) описание |
| Ключ | Маскиран префикс (напр. pk_live_••••••••) с бутон Reveal до него |
| Собственик | ME за лични ключове, TEAM за ключове на организация или споделени с екип |
| IP Allowlist | Ограничени IP адреси, ако са зададени, или "All IPs", ако няма ограничения |
| Изтича на | Дата на изтичане, ако е зададена, или "Never" |
| Статус | Активен или Неактивен |
| Създаден | Кога е създаден ключът |
| Последно използван | Кога ключът последно е направил request |
Използвайте полето за търсене, за да филтрирате по име или описание, и филтъра за статус, за да покажете само активни или неактивни ключове.
Създаване на ключ
Кликнете върху Create Key и попълнете:
| Поле | Задължително | Описание |
|---|---|---|
| Име | Да | Описателен етикет (напр. "production-scraper" или "staging-test") |
| Описание | Не | Бележки за какво се използва този ключ |
Ако принадлежите към организация, можете също да присвоите ключа на тази организация вместо на личния си акаунт.
Пълният ключ се показва веднъж веднага след създаването в готов за копиране диалогов прозорец. Можете също да го видите отново по-късно чрез Reveal (вижте по-долу), стига ключът да е създаден след пускането на функцията за разкриване.
Ключовете използват префикса pk_live_ и изглеждат така: pk_live_a1b2c3d4e5f6.... Ще получите потвърждение по имейл, когато бъде създаден нов ключ.
Разкриване на ключ
Кликнете върху иконата с око до маскирания префикс на ключа, за да видите отново пълния му таен ключ. Таблото за управление ще ви помоли да потвърдите, след което ще отвори диалогов прозорец с чистия ключ, бутон за копиране и 15-секундно обратно отброяване. След обратното отброяване диалоговият прозорец изчиства тайния ключ от страницата.
Всяко разкриване се записва в регистъра за одит (audit log), тъй като разкрива активни данни за достъп.
Наследени ключове
Ключовете, създадени преди пускането на тази функция, показват икона с катинар вместо око и не могат да бъдат разкривани. Съхраняван е само техният хеш, така че оригиналният таен ключ е невъзстановим. За да прехвърлите наследен ключ, кликнете върху менюто за действия и изберете Regenerate. Новият таен ключ ще може да се разкрива от този момент нататък.
Кой може да разкрива
| Роля | Може да разкрива |
|---|---|
| Собственик на ключа | Да |
| Собственик / администратор на организацията (за ключове на организацията) | Да |
Член на екип с права write или admin |
Да |
Член на екип с права read |
Не |
Редактиране на ключ
Кликнете върху Edit на всеки ред, за да актуализирате:
- Показвано име и описание
- IP allowlist (по един IP адрес на ред, оставете празно, за да разрешите всеки изходящ IP адрес)
- Дата на изтичане (оставете празно за безсрочен ключ)
Другите настройки (присвояване към организация, собственик) не могат да се редактират. Създайте нов ключ, ако имате нужда от различна собственост.
Активиране и деактивиране
Използвайте бутона Disable / Enable на реда, за да превключите статуса на ключа. Деактивирането на ключ блокира всички API requests, които го използват. Можете да го активирате отново по всяко време. Промяната влиза в сила в рамките на секунди.
Регенериране на ключ
Ако подозирате, че ключът е компрометиран, отворете менюто за действия (бутона с трите точки) и изберете Regenerate. Това създава нов таен ключ за същия ID на ключа. Старият таен ключ спира да работи незабавно. Всички останали настройки (име, присвояване към организация, IP allowlist, изтичане) остават същите.
Новият таен ключ остава достъпен за разкриване след затваряне на диалоговия прозорец, така че не е необходимо да го копирате перфектно от първия път.
Изтриване на ключ
Отворете менюто за действия и изберете Delete. По подразбиране изтриването деактивира ключа (soft delete). Можете да го премахнете за постоянно от диалоговия прозорец за потвърждение.
Ще получите известие по имейл, когато ключът бъде изтрит.
Ключове на организация
Ключовете, създадени в рамките на организация, се споделят с членовете на организацията въз основа на тяхната роля:
- Собствениците и администраторите виждат и редактират всички ключове на организацията.
- Членовете виждат само ключове, присвоени на екипи, към които принадлежат.
Ключовете на организацията се добавят автоматично към екипа по подразбиране на организацията при създаването им.
Права за ключове чрез екипи
Екипите контролират кой до кои ключове има достъп. Всяко присвояване на ключ към екип има ниво на права:
| Права | Преглед на ключа | Разкриване | Редактиране на настройките на ключа |
|---|---|---|---|
| read | Да | Не | Не |
| write | Да | Да | Да |
| admin | Да | Да | Да |
Свързани теми
- Authentication: Как работят API ключовете с API
- Organizations and Teams: Настройване на споделен достъп
- Dashboard Overview: Всички секции на таблото за управление