Service API түлхүүрийг хэрхэн үүсгэж, удирдах вэ?

Service API түлхүүр нь гадаад аппликейшн, скриптэд public API-аар дамжуулан таны GravityZone-той аюулгүй харилцах боломж олгоно. Тусдаа хэрэглэгчийн данстай холбогддог personal API түлхүүрээс ялгаатай нь service API түлхүүр нь тусгай service account-аар ажилладаг тул багийн гишүүд солигдсон ч идэвхтэй хэвээр байна.

Service API түлхүүрийг дараах тохиолдолд ашиглана.

• Тодорхой ажилтны данснаас хамаарах ёсгүй автомат ажлын урсгал, хяналтын хэрэгсэл, гуравдагч талын интеграцид API хандалт хэрэгтэй үед.
• Багийн гишүүд гарсан эсвэл үүрэг нь өөрчлөгдөхөд интеграци тасрахгүй байх шаардлагатай үед.
• Интеграцид хэрэглэгчийн бүрэн эрх олгохгүйгээр тодорхой, хязгаарлагдмал эрх болон target (объект) оноох үед.

Service API түлхүүрийг GravityZone-ийн үндсэн цэсний Accounts > Service API keys хуудаснаас удирдна. Энэ цэсийг харахын тулд таны GravityZone данс Manage Service API Keys эрхтэй байх ёстой.

Тойм

Service API түлхүүрийн онцлогийг дараах жагсаалтад нэгтгэв.

• Authentication (Баталгаажуулалт) — X-API-Key HTTP header
• Protocol (Протокол) — HTTP POST дээрх JSON-RPC 2.0
• Компани тус бүрийн идэвхтэй түлхүүрийн дээд тоо — 50
• Хүчинтэй хугацааны дээд хязгаар — үүсгэснээс хойш 1 жил
• Event Push Service — дэмжигдэхгүй
• Шаардлагатай эрх — Manage Service API Keys (дансны тохиргооноос тохируулна)
• API түлхүүрийн харагдах байдал — зөвхөн үүсгэх үед нэг удаа харагдана

Service API түлхүүрийг үүсгэх, засах, хувилах (clone), түр зогсоох, идэвхжүүлэх, устгахын тулд таны данс Manage Service API Keys эрхтэй байх ёстой.

Customer компанийн хэрэглэгчийн хувьд танд дараах эрхүүд бүрэн байх ёстой.

• Manage Networks
• Manage Endpoint Settings
• Manage Users
• Manage Company

Та зөвхөн оноогдсон target нь таны харагдах хүрээнд багтаж байгаа түлхүүрүүдийг удирдаж чадна. Илүү өргөн target-тэй түлхүүрүүд зөвхөн унших горимд харагдана.

Баталгаажуулалт

Service API түлхүүр нь X-API-Key HTTP header-ээр баталгаажна. Дэлгэрэнгүйг Public API хуудаснаас үзнэ үү.

Personal API түлхүүрээс ялгаа

Service API түлхүүр нь personal API түлхүүрээс хэд хэдэн зүйлээрээ ялгаатай. Хураангуйг доор харуулав.

• Баталгаажуулах header — Personal: Authorization: Basic <base64>; Service: X-API-Key: <key>
• Холбогдсон объект — Personal: хувь хэрэглэгчийн данс; Service: бие даасан service account
• Амьдралын мөчлөгийн хамаарал — Personal: хэрэглэгч устгагдвал ажиллахаа болино; Service: үүсгэсэн хүний төлвөөс үл хамааран идэвхтэй байна
• Хүчинтэй хугацаа — Personal: заавал байх хугацаагүй; Service: заавал тогтоох, дээд тал нь 1 жил
• Удирдах эрх — Personal: хэрэглэгч бүр өөрийн түлхүүрийг удирдана; Service: Manage Service API Keys шаардлагатай
• Event Push Service — Personal: дэмжинэ; Service: дэмжихгүй
• Холбогдох данс — Personal: хэрэглэгчийн данс (GravityZone консолд нэвтэрч болно); Service: service account (зөвхөн API, GravityZone консолд нэвтрэхгүй)
• GravityZone интерфэйс дэх байрлал — Personal: My account хуудасны API keys хэсэг; Service: Accounts цэсийн Service API Keys хуудас

Гуравдагч этгээдэд ашиглуулах

Хэрэв та API түлхүүрээ гуравдагч этгээдтэй хуваалцахаар шийдвэл хүлээн авагч нь Bitdefender Technology Access Program (TAP)-ийн өргөдлийн маягт-ыг илгээсний дараа л түүнийг ашиглаж болно.

Өргөдлийн маягтыг илгээснээр Bitdefender Technology Access Program (TAP)-ийн Үйлчилгээний нөхцөл-ийг хүлээн зөвшөөрсөнд тооцогдоно.

Service API түлхүүрүүдийг харах

Service API keys хуудас нь компанид үүсгэсэн бүх service API түлхүүрийг харуулна. Энэ хуудсаар түлхүүрийн дэлгэрэнгүйг харах, үр дүнг шүүх, нэг буюу хэд хэдэн түлхүүрт үйлдэл хийх боломжтой.

Хуудас дараах элементүүдтэй.

1. 1Actions – Сонгосон нэг буюу хэд хэдэн түлхүүрт хийх үйлдлүүд:

- Add key – Шинэ service API түлхүүр үүсгэнэ.
- Clone – Одоо байгаа түлхүүрийн тохиргоог хуулж, түлхүүрийн шинэ утга үүсгэнэ.
- Delete – Сонгосон түлхүүр болон холбогдох service account-уудыг бүрмөсөн устгана.
- More actions - Suspend (түр идэвхгүй болгох) эсвэл Activate (хандалтыг сэргээх).

Түлхүүрийн нэрийг дарж түлхүүрийг засах боломжтой.

2. 2UI controls (Хяналтын товчнууд):

- Reset view – Шүүлтүүр болон баганын (дараалал, хэмжээ) бүх өөрчлөлтийг буцаана.
- Show or hide filters – Шүүлтүүрийн хэсгийг харуулах/нуух.
- Open settings – Харуулах баганыг сонгоно. Compact view-г идэвхжүүлбэл нэг хуудсанд илүү олон түлхүүр харагдана.

3. 3Filters – Түлхүүрийн шинж чанараар жагсаалтыг нарийсгана. Шүүлтүүрийн бүх өөрчлөлтийг буцаахын тулд Reset filters дарна.

Дэлгэрэнгүйг доорх Шүүлтүүр хэсгээс үзнэ үү.

4. 4Column headers – Түлхүүрийн дэлгэрэнгүйг багана тус бүрээр харуулна.

Дэлгэрэнгүйг доорх Баганууд хэсгээс үзнэ үү.

5. 5Key selector – Олноор нь үйлдэл хийхийн тулд нэг буюу хэд хэдэн түлхүүр сонгоно.

Шүүлтүүр

Харагдаж буй түлхүүрүүдийг дараах шүүлтүүрээр нарийсгаж болно.

• Service account — Текст; далдлагдсан түлхүүрийн утга эсвэл service account-ийн ID-ийн тэмдэгтүүдтэй тохируулна.
• API key status — Сонголт; Active, Suspended, Expiring soon (дуусахад 7 хоногоос бага үлдсэн), Expired. Дэлгэрэнгүйг доорх API түлхүүрийн төлөв хэсгээс үзнэ үү.
• Description — Текст; түлхүүрийн тайлбараас хайна.
• Created by — Хэрэглэгч; түлхүүрийг хэн үүсгэснийг харуулна.
• Created on — Огнооны муж; календараас эхлэх, дуусах огноог сонгож хугацаа тодорхойлно.
• Expires on — Урьдчилан тодорхойлсон интервал; 180, 90, 30, 7 эсвэл 1 хоногоос бага хугацаанд.
• Enabled APIs — Сонголт; оноосон API эрхээр шүүнэ.

Баганууд

Дараах баганууд байдаг.

• API key - Түлхүүрийн далдлагдсан утга (жишээ нь: h8s7s*****). Түлхүүрийг задруулахгүйгээр таниулна.
• Service account - Service account-ийн дотоод ID. Жишээ нь: service-account-c6e1-73985981@6a55f42c7552ea8dd10e3992.service.internal
• API key status - Түлхүүрийн одоогийн төлөв. Дэлгэрэнгүй тайлбарыг харахын тулд заагчаа авчирна.
• Created by - Түлхүүрийг үүсгэсэн хэрэглэгчийн и-мэйл.
• Description - Үүсгэх үед оруулсан тайлбар.
• Created on - Түлхүүр үүссэн огноо.
• Expires on - Түлхүүрийн дуусах огноо (UTC).
• Last used - Түлхүүрээр API дуудлага хийсэн сүүлийн огноо.
• Enabled APIs - Түлхүүрт оноосон эрхүүд.

API түлхүүрийн төлөв

Service API түлхүүр дараах төлөвтэй байна.

• Active — Түлхүүр ажиллаж, API дуудлага хүлээн авч байна. Тайлбар: «This API key is active.»
• Expiring soon — Түлхүүр дуусахад 7 хоногоос бага үлдсэн. Тайлбар: «This API key is expiring soon. Create a new one to avoid interruption.»
• Suspended — Түлхүүрийг гараар идэвхгүй болгосон. Тайлбар: «This API key is suspended and cannot be used until reactivated.»
• Expired — Түлхүүрийн хугацаа дууссан. Тайлбар: «This API key has expired and can no longer be used. Create a new key to regain access.»

Service API түлхүүрүүдийг удирдах

Энэ хэсэгт GravityZone-д service API түлхүүрийг үүсгэх, засах, хувилах, түр зогсоох, идэвхжүүлэх, устгах аргыг тайлбарлана.

Түлхүүр нэмэх

Гадаад аппликейшн эсвэл скриптийг хэрэглэгчийн данснаас үл хамааран GravityZone API-д баталгаажуулах service API түлхүүр үүсгэнэ.

Service API түлхүүр үүсгэхдээ:

1. 1Үндсэн цэснээс Service API keys-ийг нээнэ.

2. 2Add key дарна.

3. 3Generate API key хуудсанд дараах тохиргоог бөглөнө.

- Description - Түлхүүрийн тайлбар оруулна. Заавал бөглөнө. Тэмдэгтийн хязгаараас хэтрэхгүй байх ёстой.

- Expires on - Дуусах огноог сонгоно. Дээд хязгаар нь өнөөдрөөс хойш нэг жил. Сонгосон огноо 7 хоногоос ойр бол «The selected expiration date is less than 7 days from today.» гэсэн анхааруулга гарна.

- Permissions - Available permissions-оос нэг буюу хэд хэдэн зүйлийг Selected permissions руу зөөнө. Жагсаалтыг шүүхийн тулд Search ашиглана. Хамгийн багадаа нэгийг сонгоно.

Available permissions: Accounts, Companies, General, Incidents, Investigation, Integrations, Licensing, Maintenance Windows, Network, Packages, PHASR, Policies, Quarantine, Reports.

- Targets - Түлхүүр хандаж болох сүлжээний объектуудыг сонгоно. Зөвхөн таны данс харж чадах target-ууд сонгогдоно.

4. 4Generate дарна. GravityZone түлхүүр болон холбогдох service account-ийг үүсгэнэ.

Түлхүүр үүссэний дараа энэ хуудас руу буцах боломжгүй.

5. 5Copy API key хуудсанд түлхүүрийн төлөв, service account-ийн нэр, түлхүүрийн утгыг шалгана.

6. 6Service API key утгын хажуугийн Copy to clipboard дарж түлхүүрийг аюулгүй газар хадгална.

> Анхааруулга: Энэ түлхүүр зөвхөн нэг удаа харагдана. Цонхыг хаасны дараа дахин авах боломжгүй. Тэр дор нь аюулгүй газар хадгална уу. Энэ түлхүүр тодорхой хэрэглэгчтэй холбогдоогүй. Зөвхөн зориулалтын интеграцид ашиглана.

7. 7API хандалтын нөхцөл болон rate limit-ийн хэсгийг уншина.

8. 8Finish дарна.

Түлхүүр засах

Service API түлхүүрийн тайлбар, эрх, target-ыг шинэчлэх, түүнийг түр зогсоох эсвэл идэвхжүүлэхийн тулд засна. Бүх өөрчлөлт тэр даруй хүчин төгөлдөр болно.

Service API түлхүүр засахдаа:

1. 1GravityZone Control Center-ийн үндсэн цэснээс Service API keys-ийг нээнэ.

2. 2Өөрчлөх түлхүүрээ дарна.

3. 3Edit service API key хуудсанд дараах хэсгүүдийг өөрчилнө.

- API key status - Active эсвэл Suspended-ийг сонгоно.
- Description - Түлхүүрийн тайлбарыг шинэчилнэ.
- Permissions - Available permissions эсвэл Selected permissions-оос нэмж, хасна.
- Targets - Түлхүүр хандаж болох сүлжээний объектуудыг өөрчилнө.

4. 4Save дарна.

Өөрчлөлт тэр даруй хүчин төгөлдөр болно.

Түлхүүр хувилах (Clone)

Одоо байгаа түлхүүрийн эрх, target-ыг өвлөсөн шинэ түлхүүр үүсгэхийн тулд service API түлхүүрийг хувилна. Шинэ, давтагдашгүй түлхүүрийн утга үүснэ. Анхны түлхүүр өөрчлөгдөхгүй.

Дараах тохиолдолд түлхүүрийг хувилна.

• Тохиргоог эхнээс нь дахин хийлгүйгээр түлхүүр шинэчлэх (rotation) үед.
• Бага зэрэг тохируулгатай, ижил төстэй хандалт шаардсан шинэ интеграцид.
• Өөр өөр интеграцид ижил суурь эрхтэй олон түлхүүр хэрэгтэй үед.

Service API түлхүүр хувилахдаа:

1. 1GravityZone Control Center-ийн үндсэн цэснээс Service API keys-ийг нээнэ.

2. 2Эх түлхүүрийг сонгоно.

3. 3Clone дарна.

4. 4Clone service API key хуудсанд өвлөгдсөн тохиргоог шалгаж, шаардлагатай бол засна.

- Description - Шинэ түлхүүрийн зориулалтад нийцүүлэн шинэчилнэ.
- Expires on - Дуусах шинэ огноог сонгоно (үүсгэсэн өдрөөс дээд тал нь нэг жил).
- Permissions - Эх түлхүүрээс өвлөгдсөн. Шаардлагатай бол нэмж, хасна.
- Targets - Эх түлхүүрээс өвлөгдсөн. Шаардлагатай бол тохируулна.

5. 5Generate дарна. GravityZone шинэ утгатай шинэ түлхүүр үүсгэнэ.

Түлхүүр үүссэний дараа энэ хуудас руу буцах боломжгүй.

6. 6Copy API key хуудсанд Service API key утгын хажуугийн Copy to clipboard дарж түлхүүрийг аюулгүй газар хадгална.

> Анхааруулга: Цонхыг хаасны дараа шинэ түлхүүр GravityZone-д дахин харагдахгүй. Аюулгүй газар хадгалж, хэнтэй ч хуваалцаж болохгүй.

7. 7Finish дарна.

Өөрийн service account бүхий шинэ service API түлхүүр үүснэ. Эх түлхүүр идэвхтэй хэвээр, өөрчлөгдөхгүй.

Түлхүүр түр зогсоох (Suspend)

Service API түлхүүрийн GravityZone-д хандах эрхийг бүрмөсөн устгахгүйгээр түр цуцлахын тулд түр зогсооно.

Дараах тохиолдолд түлхүүрийг түр зогсооно.

• Түлхүүр алдагдсан гэж сэжиглэж, шалгах шаардлагатай үед.
• Засвар үйлчилгээ эсвэл туршилтын үеэр интеграцийг түр зогсоох үед.
• Гуравдагч талын нийлүүлэгчийн хандалтыг түр цуцлах шаардлагатай үед.

Нэг буюу хэд хэдэн service API түлхүүрийг түр зогсооход:

1. 1GravityZone Control Center-ийн үндсэн цэснээс Service API keys-ийг нээнэ.

2. 2Нэг буюу хэд хэдэн түлхүүр сонгоно.

3. 3More actions-ийг нээж Suspend-ийг сонгоно.

4. 4Баталгаажуулах мессежийг уншина.

5. 5Suspend дарна.

Түлхүүрүүдийн төлөв Suspended болно. Түр зогсоосон түлхүүрээр хийсэн API дуудлагад -32000 (Server error) хариу ирнэ.

Хандалтыг сэргээхийн тулд түлхүүрийг идэвхжүүлнэ.

Түлхүүр идэвхжүүлэх (Activate)

Түр зогсоосон service API түлхүүрийн GravityZone-д хандах эрхийг сэргээхийн тулд идэвхжүүлнэ.

Дараах тохиолдолд түлхүүрийг идэвхжүүлнэ.

• Шалгалт дуусаж, түлхүүр аюулгүй нь батлагдсан үед.
• Засвар дуусаж, интеграцийг үргэлжлүүлэх үед.
• Түр зогссон нийлүүлэгчтэй хамтын ажиллагаа дахин эхэлсэн үед.

Нэг буюу хэд хэдэн түр зогсоосон service API түлхүүрийг идэвхжүүлэхдээ:

1. 1GravityZone Control Center-ийн үндсэн цэснээс Service API keys-ийг нээнэ.

2. 2Түр зогсоосон нэг буюу хэд хэдэн түлхүүр сонгоно.

3. 3More actions-ийг нээж Activate-ийг сонгоно.

4. 4Баталгаажуулах мессежийг уншина.

5. 5Activate дарна.

Түлхүүрүүдийн төлөв Active болж буцна. Интеграци түр зогсоохын өмнөх эрх, target-тайгаа тэр даруй дахин ажиллана.

Түлхүүр устгах (Delete)

Service API түлхүүр болон холбогдох service account-ийг GravityZone-оос бүрмөсөн устгана. Устгасан түлхүүрийг сэргээх боломжгүй.

Дараах тохиолдолд түлхүүрийг устгана.

• Интеграцийг бүрмөсөн зогсоосон үед.
• Түлхүүр шинэчлэлт дууссан, хуучин түлхүүрийг ашиглахаа больсон үед.
• Түлхүүр андуурч үүссэн эсвэл ашиглах эрхгүй болсон үед.
• Түлхүүр шаардлагагүй болж, 50 түлхүүрийн хязгаарт зай гаргахын тулд цэвэрлэх үед.

Нэг буюу хэд хэдэн service API түлхүүрийг устгахдаа:

1. 1GravityZone Control Center-ийн үндсэн цэснээс Service API keys-ийг нээнэ.

2. 2Нэг буюу хэд хэдэн түлхүүр сонгоно.

3. 3Delete дарна.

4. 4Баталгаажуулах мессежийг уншина.

5. 5Delete дарна.

GravityZone сонгосон түлхүүрүүд болон холбогдох service account-уудыг бүрмөсөн устгана. API хандалтыг сэргээхийн тулд шинэ түлхүүр үүсгэх эсвэл одоо байгаа түлхүүрийг хувилж, интеграцуудаа дахин тохируулна.

Хэрэглэгчийн үйл ажиллагаа

Service API түлхүүр дээр хийсэн бүх үйлдэл аудитын зорилгоор GravityZone-д бүртгэгдэнэ. User activity хуудсаар service API түлхүүрийг хэн, хэзээ үүсгэсэн, зассан, түр зогсоосон, идэвхжүүлсэн, устгасныг харна.

Service API түлхүүр дээр хийсэн үйлдлийг харахдаа:

1. 1GravityZone Control Center-ийн үндсэн цэснээс User activity-г нээнэ.
2. 2Area-д Service API keys-ийг сонгоно.
3. 3Action-д Created, Activated, Suspended эсвэл Deleted-ийн аль нэгийг сонгоно.
4. 4Search дарна.
5. 5Үр дүнгийн жагсаалтаас мөр бүрийг дарж дэлгэрэнгүйг харна.

Service API түлхүүрийн амьдралын мөчлөг

Энэ хэсэгт service API түлхүүр цаг хугацааны явцад хэрхэн ажиллахыг тайлбарлана: хүчинтэй хугацааны дүрэм, мэдэгдлийн хуваарь, түлхүүр шинэчлэх (rotation) зөвлөмж.

Хүчинтэй хугацаа

Service API түлхүүр бүрт үүсгэх үедээ дуусах огноо тогтоох ёстой. Хүчинтэй байх дээд хугацаа нь үүсгэсэн огнооноос нэг жил.

Түлхүүрийн хугацаа дууссаны дараа:

• API дуудлагыг баталгаажуулах боломжгүй болно.
• GravityZone түүнийг hash-lookup алхамд татгалзана.
• Service API keys хуудсанд төлөв нь Expired болно.
• Түүнийг ашиглаж буй аливаа интеграцид -32000 (Server error) хариу ирнэ.

Хугацаа дууссаны дараа хандалтыг сэргээхийн тулд шинэ түлхүүр үүсгэж (эсвэл хугацаа дууссан түлхүүрийг хувилж) интеграцуудаа шинэчилнэ.

Дуусах хугацааны мэдэгдэл

GravityZone Manage Service API Keys эрхтэй бүх хэрэглэгчид дараах интервалаар мэдэгдэл болон и-мэйл илгээнэ.

• Дуусахаас 90 хоногийн өмнө
• Дуусахаас 30 хоногийн өмнө
• Дуусахаас 7 хоногийн өмнө
• Дуусахаас 1 хоногийн өмнө
• Дууссан даруйд

Эдгээр мэдэгдлийн харагдах байдлыг (GravityZone Control Center, и-мэйл) Notifications Settings хуудсанд тохируулж болно.

Түлхүүр шинэчлэх (rotation) зөвлөмжит хуваарь

• Өндөр ач холбогдолтой интеграци (бодит орчны хяналт, аюулгүй байдлын хэрэгсэл) — дуусахаас 90 хоногийн өмнө эхэлнэ; сайтар туршиж, буцаах хугацаа гаргана.
• Дунд ач холбогдолтой интеграци (тайлан, үе үеийн синхрончлол) — дуусахаас 30 хоногийн өмнө эхэлнэ; шинэчлэх, шалгах стандарт мөчлөгт хангалттай.
• Бага ач холбогдолтой интеграци (дотоод хэрэгсэл, хөгжүүлэлт/туршилт) — дуусахаас 7 хоногийн өмнө эхэлнэ; асуудал гарсан ч нөлөө бага.