Mengembangkan integrasi kustom pertama Anda

Didukung di:

Google SecOps SOAR

Penting: Dokumen ini menjelaskan cara membangun integrasi kustom menggunakan IDE bawaan. Meskipun masih didukung untuk prototipe cepat, ini dianggap sebagai alur kerja lama. Praktik terbaik saat ini adalah mengembangkan integrasi secara lokal menggunakan IDE Anda sendiri dan mengelolanya melalui GitHub. Untuk mengetahui informasi selengkapnya tentang alur kerja GitOps modern, lihat Membangun integrasi kustom.

Dokumen ini menjelaskan cara membuat integrasi kustom di Lingkungan Pengembangan Terpadu (IDE) dengan struktur yang sama seperti integrasi komersial. Integrasi kustom muncul di Content Hub, tempat Anda dapat mengonfigurasinya untuk berbagai lingkungan yang akan digunakan dalam playbook, tindakan manual, dan agen jarak jauh. Anda juga dapat mengimpor dan mengekspornya, seperti item IDE lainnya.

Dalam contoh integrasi kustom ini, Anda akan membangun integrasi kustom untuk produk WHOIS XML API. Mulailah dengan membuat integrasi pertama Anda, termasuk proses pendaftaran ke produk WHOIS, termasuk mendaftar ke produk dan membuat kunci API yang diperlukan.

Pilih produk yang akan diintegrasikan

1. Dalam contoh ini, Anda akan berintegrasi dengan produk WHOIS XML API, alat open source gratis yang menyediakan akses API ke data domain, termasuk nama pendaftar, organisasi, alamat email, alamat pendaftaran, informasi pendaftar, tanggal pembuatan, habis masa berlaku, dan pembaruan domain, ketersediaan, dan usia domain.
2. Buka WHOIS XML API/ dan daftar.
3. Setelah login, dapatkan kunci API dari halaman akun Anda: https://user.whoisxmlapi.com/products
4. Gunakan kunci API ini dalam parameter integrasi Anda.

Membuat integrasi kustom pertama di IDE

Untuk membuat integrasi kustom pertama Anda di IDE, ikuti langkah-langkah berikut:

1. Di halaman Response > IDE, klik add Add untuk menambahkan item IDE baru.
2. Pilih tombol pilihan Integration, lalu masukkan nama untuk integrasi.
3. Klik Create. Integrasi akan muncul dengan ikon integrasi kustom.
4. Klik Setelan.
5. Dalam dialog integrasi, tentukan Icon, Description, Python Dependencies, dan Integration Parameters.
   Dalam contoh ini, detail berikut akan muncul:
• Gambar logo WhoisXML API diupload. Gambar ini muncul di Hub Konten dengan integrasi.
• Ikon SVG telah ditambahkan di samping integrasi di IDE dengan deskripsi singkat dan satu parameter, yaitu Kunci API. Ini adalah parameter yang diperlukan Produk Who Is XML API untuk konfigurasi integrasi.
• Anda tidak memerlukan library Python tambahan untuk integrasi ini. Secara default, integrasi ditetapkan untuk berjalan di Python 3.11, dan Anda dapat mengubah versinya di Setelan.
Catatan: Dependensi skrip adalah library Python yang harus diimpor oleh integrasi kustom Anda. Anda dapat menambahkannya dalam format, seperti file Wheel (`WHL`), tarball (`TAR`), arsip Gzip (`GZ`), atau file Python (`PY`). Setiap integrasi berjalan di lingkungan virtualnya sendiri, sehingga Anda dapat menyertakan versi library tertentu meskipun versi yang berbeda sudah diinstal di sistem. Misalnya, jika Anda memerlukan versi tertentu dari library permintaan, download dari sumber tepercaya (seperti PyPI atau GitHub) dan tambahkan ke dependensi skrip. Jika dependensi tidak ada di lingkungan virtual, integrasi akan menggunakan versi yang diinstal sistem.

Mengonfigurasi instance default

Setelah membuat integrasi, Anda dapat melihatnya di Integrasi Respons Google SecOps (telusuri nama integrasi di kotak penelusuran atau filter jenis Integrasi menurut Integrasi Kustom) dengan gambar, deskripsi, dan parameter yang Anda tentukan untuk integrasi.

1. Klik Settings > Configure a default Instance.
2. Masukkan kunci API Anda, lalu klik Simpan.
3. Opsional: Untuk mengonfigurasi integrasi untuk lingkungan lain (bukan lingkungan default), klik tab Configure dan tetapkan parameter untuk instance tersebut.
Catatan: Anda harus membuat tindakan Ping sebelum Tombol uji bawaan dapat berfungsi.

Membuat tindakan Ping

1. Di Response > IDE, klik add Add > Add New IDE Item.
2. Pilih tombol pilihan Action, masukkan nama, dan pilih integrasi.
3. Klik Create. Tinjau template kode yang dihasilkan.
4. Salin kode berikut untuk tindakan Ping. Tindakan Ping menggunakan parameter API Key yang Anda konfigurasi untuk integrasi dan menempatkannya di URL yang disediakan oleh produk untuk tujuan pengujian. Untuk mengetahui detailnya, lihat Membuat tindakan kustom.

from SiemplifyAction import SiemplifyAction
from SiemplifyUtils import output_handler
import requests

INTEGRATION_NAME = "My first Integration - Whois XML API"
SCRIPT_NAME = "Whois XML API Ping"

@output_handler
def main():
    siemplify = SiemplifyAction()
    siemplify.script_name = SCRIPT_NAME

    api_key = siemplify.extract_configuration_param(provider_name=INTEGRATION_NAME,
                                                    param_name="API Key")
    url = "https://www.whoisxmlapi.com/whoisserver/WhoisService?apiKey={api_key}&domainName=google.com".format(api_key=api_key)

    res = requests.get(url)
    res.raise_for_status()

    if "ApiKey authenticate failed" in res.content.decode("utf-8"):
        raise Exception("Error, bad credentials")

    siemplify.end("Successful Connection", True)
if __name__ == "__main__":
    main() 

5. Klik tombol di atas tindakan, lalu klik Simpan untuk menguji koneksi ke produk.
6. Buka Google SecOps Marketplace, klik Configure default instance, dan pastikan integrasi telah dikonfigurasi dan disimpan.
7. Klik Test untuk menguji integrasi. Koneksi yang berhasil akan menampilkan tanda centang hijau; koneksi yang gagal akan menampilkan tanda X dengan error terkait.
8. Setelah menyelesaikan autentikasi, buat tindakan kustom pertama Anda dalam integrasi kustom. Untuk mengetahui detailnya, lihat Membuat tindakan kustom.

Perlu bantuan lain? Dapatkan jawaban dari anggota Komunitas dan profesional Google SecOps.