Akses API (untuk developer)

Pengaturan → Integrasi (/app/settings/integrations), kartu Akses API (untuk developer) di bagian bawah halaman. Hanya untuk pemilik dan admin. "Hubungkan OmniBrand ke sistem Anda sendiri, Zapier, atau Make untuk membuat postingan, menambahkan kontak, atau membaca analitik secara otomatis." Kunci memungkinkan perangkat lunak Anda sendiri memanggil API publik OmniBrand dengan header Authorization: Bearer ob_live_… Bagian bawah kartu, Endpoint API, menunjukkan alamat untuk mengirim permintaan tersebut ("Alamat yang dijawab API publik. Kirim setiap permintaan ke sana, dengan salah satu kunci di atas."). Tautan lama ke /app/settings#developer membuka kartu ini.

Paket yang mencakupnya

Akses API termasuk dalam paket Agency dan Enterprise. Di Gratis, Starter, dan Pro, serta selama uji coba Pro 14 hari, kartu hanya menampilkan "Akses API tersedia di paket Agency." dengan tautan Lihat paket ke Paket & penggunaan; tidak ada formulir kunci. Kartu paket di Paket & penggunaan dan di /pricing mencantumkan Akses API untuk Agency dan Enterprise.

Saat paket berubah

• Saat akun pindah ke paket tanpa akses API (penurunan paket, pengembalian dana, atau akhir uji coba), kuncinya dijeda: tetap tersimpan dan tidak ada yang dihapus, tetapi setiap panggilan dengan kunci itu ditolak dengan "API access is available on the Agency and Enterprise plans. Upgrade under Settings > Plan & usage to use API keys." (HTTP 403, kode api_access_not_in_plan).
• Pemilik akun menerima satu email, Your API keys are paused ("Kunci API Anda dijeda karena paket Anda tidak lagi mencakup akses API…"), dengan tombol Lihat paket.
• Kembali ke Agency atau Enterprise mengaktifkan lagi kunci yang sama dalam satu menit. Anda tidak perlu membuat kunci baru.
• Selama dijeda, kunci tidak ditampilkan dan tidak dapat dibuat atau dirotasi. Untuk menghentikan kunci selamanya, kembali ke paket dengan akses API lalu klik Cabut pada kunci itu, atau hubungi dukungan.

Langkah demi langkah: buat kunci

1. Ketik nama di Nama kunci (misalnya bot CI), hingga 60 karakter, sehingga Anda nanti tahu apa yang menggunakannya. Tanpa nama (atau hanya spasi), Buat kunci tidak menghasilkan apa pun dan kotak bertuliskan "Berikan nama pada kunci, misalnya "Website sync"." Spasi sebelum dan sesudah nama dihapus.
2. Di Lingkup kunci, pilih hanya baca (membaca data) atau baca + tulis (juga membuat dan mengubah sesuatu).
3. Klik Buat kunci.
4. Kotak kuning menampilkan "Kunci baru untuk "(nama)". Salin sekarang: hanya ditampilkan sekali." dan kunci penuh, dengan Salin (kemudian tertulis Copy) dan Saya sudah menyimpannya, yang menutup kotak. Salin kunci sekarang dan simpan di tempat yang aman; OmniBrand hanya menyimpan sidik jari dan tidak akan pernah menampilkannya lagi.

Daftar

Setiap tombol menampilkan namanya, karakter pertama (ob_live_...), cakupannya, kapan terakhir kali digunakan ("digunakan ..." atau "tidak pernah digunakan") dan "kedaluwarsa ..." dengan tanggal akhirnya.

• Rotasi: menanyakan terlebih dahulu: "Putar "(nama)" (awalan…)? Anda langsung mendapatkan kunci baru. Kunci saat ini terus bekerja selama 24 jam lalu berhenti, jadi letakkan kunci baru di mana pun kunci lama digunakan sebelum itu." Klik Rotasi kunci untuk melanjutkan, atau Batal. Kunci baru, dengan nama dan cakupan yang sama, ditampilkan satu kali di kotak kuning yang sama. Kunci lama tetap berfungsi selama 24 jam agar Anda dapat mengalihkan integrasi, lalu berhenti. Sampai saat itu, kunci lama tetap ada di daftar, tidak dicoret, dengan "Kunci lama berfungsi hingga [tanggal dan waktu]" dan tombol Cabut.
• Cabut: bertanya "Cabut kunci (nama) (awalan…)? Apa pun yang menggunakannya langsung berhenti berfungsi, dan kunci yang dicabut tidak dapat diaktifkan kembali." Jendela berjudul Cabut kunci?; klik Cabut kunci untuk langsung menghentikan kunci, atau Batal untuk menyimpannya. Ini juga berlaku untuk kunci lama selama 24 jam setelah rotasi: jika Anda merotasi karena kunci bocor, klik Cabut pada kunci lama agar langsung berhenti. Kunci yang dicabut (dan kunci yang dirotasi setelah 24 jamnya berakhir) tetap ada di daftar, dicoret, dengan label merah "Dicabut pada (tanggal)" di bawah namanya.

Siapa yang punya kunci

• Kunci milik orang yang membuatnya, dan mencakup workspace di mana orang tersebut adalah pemilik atau admin pada saat pembuatan.
• Aplikasi ini hanya berfungsi selama pembuatnya masih menjadi pemilik aktif atau admin dari setiap workspace yang dicakapnya. Jika mereka dihapus, diturunkan jabatannya, atau login mereka dinonaktifkan, panggilan gagal dengan tulisan "Orang yang membuat kunci API ini tidak lagi mengelola workspace-nya. Minta admin saat ini untuk mengeluarkan kunci baru."
• Anda lihat, putar dan cabut hanya kunci yang workspace-nya Anda kelola sendiri. Dalam akun dengan banyak workspace klien, admin satu klien tidak dapat melihat kunci klien lain.

Jika sesuatu salah

• "This API key has expired. Rotate it under Settings > Integrations > API access.": kunci berlaku satu tahun. Klik Rotasi pada kunci di Akses API (untuk developer) (atau buat kunci baru) dan perbarui integrasi Anda.
• "Kunci API tidak valid atau dicabut": kunci dicabut, masa giliran rotasi 24 jam berakhir, atau disalin secara tidak lengkap.
• Kunci API tidak dapat membuat, memutar, atau mencabut kunci lain; hanya orang yang masuk yang dapat melakukannya.
• "Endpoint ini tidak tersedia untuk kunci API": panggilan itu hanya untuk orang yang sudah masuk, apa pun cakupan kuncinya. Kunci tidak pernah dapat menjangkau: anggota dan undangan (/workspaces/{id}/members, /workspaces/{id}/invitations, /invitations), membuat, mengganti nama, mengarsipkan, membatalkan arsip, atau menghapus workspace, webhook keluar (/workspaces/{id}/webhooks), ekspor, rantai persetujuan, jadwal laporan, menghubungkan, memutuskan, atau menghapus saluran atau mengubah pemiliknya, logo, profil, dan onboarding organisasi, serta apa pun di bawah /auth, /billing, /admin, atau /tenant/api-keys. Lakukan hal-hal ini di aplikasi, dengan masuk sebagai pemilik atau admin. AI melalui kunci mencakup teks postingan, ide, gambar, penulisan ulang, hashtag, teks alt, dan pemilahan pesan, hingga 10 panggilan per menit dan 300 per hari per kunci ("API key AI rate limit exceeded"); video, AI Studio, dan alat bantu AI lainnya hanya untuk orang yang sudah masuk. Tugas, sumber, dan pengaturan Market Watch, bot, serta pengaturan ruang kerja seperti triase otomatis juga hanya dapat diubah oleh orang yang sudah masuk. Mengaktifkan atau menonaktifkan dukungan, mengubah klasifikasi AI-nya, dan pembacaan AI Brand Health juga memerlukan orang yang sudah masuk, dan laporan yang diminta dengan kunci hanya menyertakan ringkasan AI jika ringkasan itu sudah ada.

Terkait

• Paket
• Integrasi: webhook keluar
• Peran dan izin
• Halaman Pengaturan