Управление на API ключове
Страницата API Keys ви позволява да създавате, преглеждате и управлявате ключовете, които вашите приложения използват за извикване на FourA API.
Преглед на вашите ключове
Страницата показва всеки ключ, до който имате достъп: личните ви ключове и всеки ключ, притежаван от организация, в която членувате. Членството предоставя достъп, така че обикновен член също вижда ключовете на организацията.
| Колона | Какво показва |
|---|---|
| Име | Екранно име и описание, ако сте задали такова |
| Собственик | Personal или името на организацията |
| Префикс на ключа | Маскиран префикс (pk_live_••••••••) с бутон Reveal или икона на катинар при наследен ключ |
| Статус | Активен или Неактивен |
| Създаден | Кога е създаден ключът |
| Последно използван | Кога ключът за последно е направил request |
Търсете по име или описание, филтрирайте по Активен или Неактивен и сортирайте по всяка колона. Посоката на сортиране се редува: низходящ, възходящ, след което изключено.
Филтърът по собственик
Ако членувате в поне една организация, до полето за търсене се появява падащо меню Owner: Everything, Personal или по един запис за всяка организация. То ограничава списъка до ключове с този собственик, а същият контрол в Overview, Metrics, Activity и Proxy следва вашия избор, така че петте страници винаги да съвпадат относно чий трафик преглеждате.
Създаване на ключ
Кликнете върху Create Key над списъка (Create API key на празната страница преди първия ви ключ) и попълнете:
| Поле | Задължително | Описание |
|---|---|---|
| Име | Да | Описателен етикет, например "production-scraper" или "staging-test" |
| Описание | Не | Бележки за какво се използва този ключ |
| Собственик | Да, ако сте в организация | Personal или всяка организация, в която членувате. Менюто се появява само ако имате поне една. |
Всеки член на организация може да създаде ключ, притежаван от нея, независимо от ролята си. Това е смисълът на настройката: използването на ключ на организация се таксува на собственика на организацията, така че разработчикът не се нуждае от личен ключ, който тихомълком да таксува него вместо компанията.
Пълният ключ се показва веднъж веднага след създаването в готов за копиране прозорец. Можете да го покажете отново по-късно с Reveal. Ключовете използват префикса pk_live_ и изглеждат като pk_live_a1b2c3d4e5f6.... Ще получите имейл, потвърждаващ създаването на ключа.
Показване на ключ
Кликнете върху иконата на око до маскирания префикс на ключ, за да видите отново пълната тайна стойност. Таблото за управление изисква потвърждение, след което отваря прозорец с ключа в свободен текст, бутон за копиране и кратко обратно броене. След обратното броене прозорецът изчиства тайната стойност от страницата.
Всяко показване се записва в одитния лог, тъй като разкрива активни идентификационни данни.
Всеки, с когото ключът е споделен, може да го покаже: неговият личен собственик или всеки член на организацията, която го притежава.
Наследени ключове
Ключовете, създадени преди пускането на функцията за показване, имат икона на катинар вместо око и не могат да се показват. Беше запазен само техният хеш, така че първоначалният secret е невъзстановим. За да прехвърлите стар ключ, отворете менюто с действия и изберете Regenerate. Новият secret ще може да се показва от този момент нататък.
Какво може да прави всяка роля
При личен ключ можете да правите всичко. При ключ на организация се прилагат три нива:
| Действие | Member | Admin | Owner |
|---|---|---|---|
| Използване и показване на ключа | Да | Да | Да |
| Преименуване, редактиране на описанието | Да | Да | Да |
| Активиране или деактивиране | Не | Да | Да |
| Регенериране на secret | Не | Да | Да |
| Изтриване | Не | Да | Да |
| Преместване извън организацията | Не | Не | Да |
Disable и Edit остават на реда, но са сиви с бележка, обясняваща причината. Regenerate, Transfer и Delete не се показват в менюто, когато ролята ви няма права за тях. API отказва същите действия, така че интеграция не може да заобиколи интерфейса.
Разпределението зависи от това какво коства всяко действие на хората, споделящи ключа. Преименуването е безопасно. Регенерирането или деактивирането спира интеграцията на всеки колега в момента, в който се случи. Преместването на ключ извън организацията го отнема от компанията и прехвърля използването му към личния план на приемащия, така че това действие е позволено само за собственика.
Редактиране на ключ
Кликнете върху Edit, за да актуализирате името и описанието. Собствеността не се променя от този диалогов прозорец: използвайте Transfer.
View Metrics в менюто с действия отваря Overview, филтриран за съответния ключ.
Активиране и деактивиране
Използвайте Disable или Enable на съответния ред. Деактивирането на ключ блокира всяка API request, която го използва, и можете да го активирате отново по всяко време. Промяната влиза в сила за секунди.
Регенериране на ключ
Ако подозирате, че даден ключ е компрометиран, отворете менюто с действия и изберете Regenerate. Това създава нов secret за същия key ID. Старият secret спира да работи незабавно. Името, собственикът и всяка друга настройка остават непроменени.
Новият secret остава видим след затваряне на диалоговия прозорец, така че не е нужно да го копирате точно от първия опит.
Прехвърляне на ключ
Transfer в менюто с действия премества ключ между лична собственост и собственост на организация, без да регенерира secret. Key ID, неговите метрики и историята на активността се запазват. Променя се само собственикът, а заедно с това и към кого се фактурира потреблението.
| Преместване | Кой може да го направи |
|---|---|
| Личен ключ към организация | Всеки, който принадлежи към тази организация |
| Ключ на организация навън, към себе си | Собственикът на организацията |
| Между две организации | Собственикът на организацията, която ключът напуска |
Ключ, който се премести в организация, се присъединява към нейния екип по подразбиране "Everyone", което го прави видим за членовете. Ключ, който се премести навън, напуска всеки екип, в който е бил.
Изтриване на ключ
Отворете менюто за действия и изберете Delete. Изтриването на ключ, който вече сте използвали, го деактивира: ключът спира да удостоверява автентичността и остава в списъка като Inactive, така че неговата история в Activity и Metrics запазва името му. Ключове, които никога не са били използвани, се премахват напълно.
Ще получите имейл при изтриване на ключ.
Ключове на организацията и таксуване
Потреблението чрез ключ на организация се отчита към плана на собственика на организацията, независимо кой е изпратил заявката. Страницата Usage & Limits на собственика отчита тези ключове заедно с неговите лични и ги разделя.
Свързани
- Authentication: Как работят API ключовете с API
- Organizations: Роли, членове и споделен достъп
- Usage & Limits: Кои ключове се отчитат към вашия план
- Dashboard Overview: Всички секции на таблото за управление