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