Управление на API ключове
Страницата API Keys ви позволява да създавате, преглеждате и управлявате ключовете, които вашите приложения използват за извикване на FourA API.
Преглед на вашите ключове
Страницата показва всеки ключ, до който имате достъп:
- Лични ключове, които сте създали директно.
- Организационни ключове, ако сте собственик или администратор на организация, или ако ключ, който притежавате, е прехвърлен към една от вашите организации.
Всеки ред в таблицата показва:
| Колона | Какво показва |
|---|---|
| Име | Показвано име и (по избор) описание |
| Ключ | Маскиран префикс (напр. pk_live_••••••••) с бутон за разкриване до него |
| Собственик | Personal за лични ключове или името на организацията за ключове, собственост на организация |
| Статус | Активен или Неактивен |
| Създаден | Кога е създаден ключът |
| Последно използван | Кога ключът е направил заявка за последен път |
Използвайте полето за търсене, за да филтрирате по име или описание, и филтъра за статус, за да покажете само активни или неактивни ключове. Заглавката на всяка колона може да се сортира.
Създаване на ключ
Кликнете върху Създаване на ключ и попълнете:
| Поле | Задължително | Описание |
|---|---|---|
| Име | Да | Описателен етикет (напр. "production-scraper" или "staging-test") |
| Описание | Не | Бележки за какво се използва този ключ |
| Собственик | Да, ако сте в организация | Личен или една от организациите, към които принадлежите. Инструментът за избор се появява само когато имате поне една организация. |
Пълният ключ се показва веднъж веднага след създаването в диалогов прозорец, готов за копиране. Можете също да го върнете по-късно чрез Разкриване (вижте по-долу).
Ключовете използват префикса pk_live_ и изглеждат като pk_live_a1b2c3d4e5f6.... Ще получите потвърждение по имейл, когато бъде създаден нов ключ.
Разкриване на ключ
Кликнете върху иконата на око до маскирания префикс на ключ, за да видите отново пълната му тайна. Таблото за управление ви моли да потвърдите, след което отваря диалогов прозорец с обикновения ключ, бутон за копиране и кратко обратно броене. След обратното броене диалоговият прозорец изтрива тайната от страницата.
Всяко разкриване се записва в одитния журнал, защото излага на показ живи идентификационни данни.
Наследени ключове
Ключовете, създадени преди да бъде пусната функцията за разкриване, показват икона на катинар вместо око и не могат да бъдат разкрити. Съхраняван е само техният хеш, така че оригиналната тайна е невъзстановима. За да превключите наследен ключ, кликнете върху менюто с действия и изберете Регенериране. Оттам нататък новата тайна може да бъде разкрита.
Кой може да разкрива
| Роля | Може да разкрива |
|---|---|
| Собственик на ключ | Да |
| Собственик или администратор на организация (за ключове, собственост на организация) | Да |
| Всеки друг | Не |
Редактиране на ключ
Кликнете върху Редактиране на който и да е ред, за да актуализирате показваното име и описанието. Собствеността (лична срещу организационна) не се променя тук. Използвайте Прехвърляне по-долу, за да преместите ключ между собственици.
Активиране и деактивиране
Използвайте бутона Деактивиране / Активиране на реда, за да превключите статуса на ключ. Деактивирането на ключ блокира всички API заявки, които го използват. Можете да го активирате отново по всяко време. Промяната влиза в сила в рамките на секунди.
Регенериране на ключ
Ако подозирате, че даден ключ е компрометиран, отворете менюто с действия (бутона с трите точки) и изберете Regenerate. Това създава нова тайна за същия идентификатор на ключа. Старата тайна спира да работи незабавно. Името, организационното присвояване и другите настройки остават същите.
Новата тайна остава видима след затваряне на диалоговия прозорец, така че не е нужно да я копирате перфектно от първия път.
Прехвърляне на ключ
Всеки ред има действие Transfer в менюто. Използвайте го, за да преместите ключ между лично и организационно притежание, без да генерирате отново тайната. Идентификаторът на ключа, неговите метрики и историята на активността му се запазват, променя се само собственикът.
Чести случаи:
- Преместване на личен ключ, който сте създали за споделен проект, в организацията, така че съотборник да може да го управлява след вас.
- Преназначаване на организационен ключ обратно към вас, ако проектът се отдели.
Можете да прехвърлите ключ, който притежавате (личен), във всяка организация, в която сте собственик или администратор, и можете да прехвърлите организационен ключ, който администрирате, към себе си или между организации, които администрирате.
Изтриване на ключ
Отворете менюто с действия и изберете Delete. Изтриването на ключ, който сте използвали преди, го изтрива меко (soft-delete): ключът спира да удостоверява, но неговата история на активност и метрики остават непокътнати. Ключове, които никога не са били използвани, могат да бъдат изтрити окончателно (hard-delete).
Ще получите известие по имейл, когато даден ключ бъде изтрит.
Организационни ключове
Ключовете, притежавани от организация, са видими за собствениците и администраторите на организацията. Членове без роля на собственик или администратор не ги виждат.
Използването на ключ, притежаван от организация, се отчита към плана на собственика на организацията.
Свързани
- Удостоверяване: Как API ключовете работят с API
- Организации и екипи: Настройване на споделен достъп
- Преглед на таблото: Всички секции на таблото