Basis pengetahuan GetMyBot

SDK pelanggan untuk iOS, Android, dan React Native

Tambahkan chat, pesan dalam aplikasi, dan push seluler GetMyBot ke aplikasi Anda. Panduan pemasangan, identitas pengguna, dan penggunaan tanpa jaringan.

Di halaman ini

SDK adalah pustaka yang dipasang oleh pengembang aplikasi Anda. SDK menambahkan chat dukungan dan pesan yang ditampilkan di dalam aplikasi (konten in-app). Misalnya, pelanggan menulis dari aplikasi iOS, lalu operator membalas di ruang kerja GetMyBot yang sama dengan percakapan dari situs.

SDK tersedia untuk iOS, Android, dan React Native. Bagian awal menjelaskan kemampuan dan pengaturan proyek. Bagian berikutnya memuat contoh pemasangan dalam kode, cara memverifikasi pengguna, dan aturan teknis. Chat memakai saluran web bot; pesan dalam aplikasi memakai dokumen dari Studio konten.

Kemampuan SDK

  • Mendaftarkan pemasangan: aplikasi mendaftar sekali, menerima token pemasangan jangka panjang, lalu menyimpannya di Keychain atau Android Keystore.
  • Mengenali pengguna: sebelum identify, pemasangan adalah pengunjung anonim. Setelahnya, riwayat pemasangan digabung dengan pelanggan yang dikenali dan terlihat di bagian GetMyBot lain.
  • Menyimpan tindakan saat offline: peristiwa, properti profil, tanda sedang mengetik, dan perubahan token push disimpan di perangkat, lalu dikirim dalam kelompok berurutan saat jaringan kembali tersedia.
  • Menyediakan chat: riwayat, pengiriman, lampiran, jumlah pesan belum dibaca, dan penanda pesan yang sudah dibaca memakai percakapan yang sama dengan operator.
  • Memperbarui chat langsung: pesan baru, perubahan, dan penghapusan dikirim melalui WebSocket. Sambungan memakai izin sekali pakai yang disebut tiket.
  • Menampilkan konten in-app: dokumen pop-up dari Studio konten, dengan catatan penayangan, tindakan, dan konversi.
  • Menerima push seluler: token perangkat didaftarkan untuk siaran dan kampanye. Pengiriman bergantung pada pengaturan server dan token yang masih berlaku.

Platform yang didukung: iOS (Swift, iOS 15+, antarmuka Objective-C, dan komponen UI opsional), Android (Kotlin, minSdk 24, antarmuka Java), serta React Native (TypeScript di atas dua SDK native). Ketiganya mengikuti spesifikasi yang sama dan diuji dengan contoh acuan yang sama. Lihat Kontrak.

Mengaktifkan proyek

SDK diatur untuk setiap bot pada halaman tersendiri di ruang kerja. Saat mengaktifkannya, tentukan aplikasi yang diizinkan. Anda akan menerima dua hal yang berbeda.

Daftar aplikasi. Masukkan bundle ID iOS dan nama paket Android. Setidaknya satu aplikasi diperlukan untuk membuat proyek; setiap daftar dapat berisi maksimal 64 entri. Aplikasi yang tidak ada di daftar mendapat jawaban server yang sama seperti kunci proyek yang tidak dikenal. Jawaban itu tidak dapat dipakai untuk menebak apakah suatu kunci benar.

Kunci proyek berbentuk sdk1_eu_<24 hex>_<32 hex>. Kunci ini publik, seperti kunci pemasangan widget, dan boleh berada di aplikasi. Kunci tidak memberi akses untuk membaca percakapan atau mengubah pengaturan. Bagian wilayah membantu ruang kerja menunjukkan server tempat proyek berada. SDK meneruskan kunci persis seperti yang diberikan tanpa menguraikannya.

Rahasia identitas berbeda dari kunci proyek dan tidak pernah dimasukkan ke aplikasi. Rahasia ini hanya ditampilkan satu kali saat proyek diaktifkan dan sekali lagi untuk setiap penggantian. Saat muncul, salin ke penyimpanan rahasia backend Anda. Ruang kerja dan API tidak dapat menampilkannya kembali.

Mengganti rahasia identitas membuat rahasia baru dan mempertahankan rahasia lama selama satu hari agar backend dapat diperbarui. Kunci proyek tidak berubah dan aplikasi yang sudah terpasang tetap bekerja.

Mencabut akses perangkat. Daftar pemasangan menampilkan platform, ID aplikasi, versi SDK, bahasa, zona waktu, status identitas pengguna, dan waktu aktivitas terakhir, hingga 200 catatan terbaru. Menghapus satu catatan langsung mencabut akses pemasangan tersebut.

Lonjakan pemasangan. Mendaftarkan pemasangan baru membuat pengunjung dan mengikuti batas akun yang sama dengan widget situs. Saat banyak pemasangan terjadi sekaligus, server menjawab 429 dengan Retry-After: 60. Pemasangan yang sudah terdaftar tetap bekerja memakai tokennya sendiri dan tidak terkena batas pendaftaran. Memasang ulang aplikasi atau menghapus penyimpanan kunci dihitung sebagai pemasangan baru. Lihat Widget situs.

Rahasia server CUSTOMER_SDK_KEY_SECRET

Ini adalah hal ketiga yang berbeda dari kunci proyek dan rahasia identitas. Rahasia ini berlaku untuk seluruh server MyBot, bukan satu proyek pelanggan. Kunci proyek ditandatangani menggunakan rahasia tersebut; tandatangannya diperiksa setiap kali SDK mulai bekerja.

Ada dua akibat penting:

Administrator server harus mengatur rahasia SDK. Jika CUSTOMER_SDK_KEY_SECRET kosong, tandatangan kunci proyek tidak dapat diperiksa. Pendaftaran pemasangan menjawab 401, sama seperti kunci yang tidak dikenal, sedangkan pengaktifan proyek baru menjawab 503. Administrator server sendiri atau server uji perlu memastikan pengaturan ini ada.

Mengganti rahasia server membuat semua kunci proyek lama tidak berlaku. Tandatangan lama tidak cocok dengan rahasia baru dan tidak dapat dibuat ulang untuk kunci lama. Akibatnya, aplikasi yang memakai kunci lama akan mendapat 401. Pemulihannya memerlukan kunci proyek baru di versi aplikasi baru, lalu rilis ke toko aplikasi. Rencanakan penggantian ini sebagai perubahan yang memerlukan rilis aplikasi.

Rahasia identitas tidak memakai tandatangan rahasia server tersebut. Menggantinya dengan masa tumpang tindih satu hari tidak mengubah kunci proyek yang sudah diterbitkan.

Memasang dan memulai SDK

Kode sumber SDK berada dalam repositori aplikasi seluler pada customer-sdk/: paket Swift MyBotSDK (customer-sdk/ios), modul Gradle mybot-sdk dengan namespace dev.gelfand.mybot.sdk (customer-sdk/android), dan paket npm @mybot/customer-sdk-react-native (customer-sdk/react-native).

Untuk memulai, siapkan kunci proyek, alamat dasar server MyBot Anda, dan ID aplikasi. SDK memakai satu alamat yang diberikan oleh aplikasi; wilayah di dalam kunci tidak membuat SDK memilih server lain.

let client = try await MyBotClient.start(
    configuration: Configuration(
        projectKey: "sdk1_eu_…",
        baseURL: URL(string: "https://api.getmybot.dev")!,
        appIdentifier: "dev.getmybot.example",
        sdkVersion: "1.0.0"
    )
)
val client = MyBotClient.start(
    context,
    MyBotConfiguration(
        projectKey = "sdk1_eu_…",
        baseUrl = "https://api.getmybot.dev",
    ),
)
const client = await MyBotClient.start({
  projectKey: "sdk1_eu_…",
  baseURL: "https://api.getmybot.dev",
  appIdentifier: "dev.getmybot.example",
});

Saat pertama dijalankan, SDK mendaftarkan pemasangan dan menyimpan tokennya. Pada peluncuran berikutnya, pemasangan yang sama dilanjutkan. Token hanya diberikan sekali. Jika hilang atau diduga bocor, SDK menggantinya tanpa mengubah identitas pengguna.

Identitas ditandatangani oleh backend Anda

Perangkat tidak boleh menyatakan sendiri siapa penggunanya. Identifikasi memakai pernyataan yang ditandatangani oleh backend Anda dengan rahasia identitas. Aplikasi hanya meneruskan hasilnya:

  1. Aplikasi meminta identitas pengguna kepada backend Anda.
  2. Backend yang sudah memverifikasi pengguna membuat JWT berumur pendek dan menandatanganinya dengan rahasia identitas.
  3. Aplikasi meneruskan string JWT ke identify. SDK tidak membaca isinya.

Server memeriksa semua aturan berikut dan menolak seluruh pernyataan jika ada satu yang salah:

{
  "alg": "HS256",
  "project_key": "sdk1_eu_…",
  "aud": "mybot-customer-sdk",
  "jti": "3f2504e0-4f89-41d3-9a0c-0305e82c3301",
  "iat": 1730000000,
  "exp": 1730000120,
  "user_id": "acct_10293",
  "properties": { "plan": "pro", "role": "admin" }
}
  • Algoritme harus HS256 dan audiens harus mybot-customer-sdk. Kolom iss, sub, dan nbf tidak boleh ada.
  • jti harus UUIDv4 baku. iat tidak boleh berada di masa depan. Masa berlaku exp - iat paling lama 300 detik.
  • user_id adalah ID tetap milik sistem Anda, sepanjang 1–256 byte. Jangan memakai email atau nomor telepon mentah yang diketik di perangkat.
  • properties boleh tidak ada. Jika ada, maksimal 16 entri, hanya bernama account_id, plan, role, atau locale, dengan nilai teks maksimal 256 byte.

Memanggil identify lagi untuk pengguna yang sama tidak membuat identitas kedua. Memanggilnya untuk pengguna lain memindahkan pemasangan ke pengguna baru. Data kontak mentah tidak diterima di API ini; daftar kolom tertutup yang sama berlaku untuk rute profil dan properti dari antrean.

Keluar akun mengganti masa identitas

Jika dua orang memakai satu ponsel secara bergantian, pesan orang pertama tidak boleh terkirim sebagai orang kedua. Karena itu, pemasangan menyimpan nomor masa identitas (identity epoch). Nilainya dimulai dari 1 dan naik satu setiap kali pengguna keluar. Server memeriksa nomor ini pada setiap permintaan dan langsung menolak permintaan dari masa sebelumnya:

  • Tindakan lama yang belum terkirim dibuang dari antrean dan tidak akan diterima lagi. SDK menghapusnya; server juga akan menolak seluruh kelompoknya.
  • Nomor urut tindakan lokal dimulai lagi dari 1.
  • Sambungan realtime ditutup segera. Tiket yang terbit sebelum keluar tidak dapat digunakan lagi.
  • Pengiriman yang belum selesai dari masa lama dibatalkan.
  • Server mencabut token push lama dalam transaksi yang sama saat mengganti masa identitas. Aplikasi tidak perlu mengingatnya secara terpisah.
  • Cache milik pengguna lama, seperti penempatan konten, jumlah pesan belum dibaca, dan properti profil tersimpan, dibersihkan.

Untuk WebSocket, proses awal sambungan tidak membawa header masa identitas seperti permintaan HTTPS biasa. SDK meminta tiket sekali pakai melalui HTTPS. Saat tiket dipakai, server membaca lagi masa identitas pemasangan dari basis data dan membandingkannya dengan masa pada tiket. Jika pengguna keluar di antara kedua langkah itu, sambungan ditolak meskipun tiket belum pernah dipakai. Dengan demikian, pengguna yang keluar tidak masuk ke percakapan pengguna berikutnya.

Mengganti token pemasangan bukan berarti keluar akun. Identitas dan nomor masanya tetap sama; pembersihan di atas tidak dilakukan.

Antrean saat offline

Tindakan yang dibuat tanpa jaringan dikirim kemudian dalam kelompok berurutan. Setiap kelompok memuat ID pelanggan, masa identitas, dan rentang nomor urut yang tidak terputus.

TindakanKegunaan
track_eventMencatat peristiwa produk. Namanya harus cocok dengan ^[a-z][a-z0-9_.]{0,63}$, yaitu aturan yang lebih ketat dari dua pemeriksaan yang berlaku.
set_propertiesMengisi properti profil dari daftar account_id, plan, role, locale.
register_push_tokenMenyimpan token APNs atau FCM secara terenkripsi, untuk sandbox atau production.
revoke_push_tokenMencabut token. Token yang tidak dikenal dianggap berhasil, bukan kesalahan.
notification_openedMencatat pembukaan pemberitahuan jika memungkinkan.
in_app_impression, in_app_actionMencatat penayangan dan tindakan untuk satu penempatan konten in-app.
typingMemberi tahu chat bahwa pengguna sedang mengetik.

Aturan server:

  • Satu kelompok berisi 1–100 tindakan. Nomor urut harus melanjutkan tepat setelah kelompok terakhir yang diterima. Nomor yang terlewat atau bertumpang tindih membuat seluruh kelompok ditolak.
  • Kelompok dengan ID yang sudah diterima untuk pemasangan dan masa identitas yang sama ditandai sebagai duplikat, tanpa menjalankan ulang tindakannya. Mengirim ulang setelah jawaban server hilang tetap aman.
  • Masa identitas yang salah membuat seluruh kelompok ditolak. Untuk kesalahan lain, hasil diberikan per tindakan dengan kode dari daftar tetap, sehingga satu properti yang salah tidak membatalkan peristiwa lain yang benar.

Batas lokal sama pada ketiga platform. Tindakan menunggu yang paling tua dibuang lebih dulu agar penyimpanan tidak tumbuh tanpa batas selama ponsel offline berminggu-minggu:

  • Maksimal 2.000 tindakan dalam antrean per pemasangan.
  • Maksimal 2 MiB data antrean yang disimpan.
  • Maksimal 7 hari usia tindakan, terlepas dari dua batas sebelumnya.

Tindakan yang sedang dikirim tidak pernah dibuang. Setiap tindakan yang dibuang memicu pemberitahuan diagnostik berisi ID lokal dan alasan jumlah, ukuran, atau usia, tanpa isi tindakan. Pengiriman yang gagal dicoba lagi mulai setelah 30 detik, dengan waktu tunggu berlipat hingga 240 detik dan variasi acak penuh. Kesalahan otorisasi tidak dicoba ulang karena merupakan penolakan akses, bukan gangguan sementara.

Chat

Jika riwayat situs dan aplikasi yang ditautkan tersedia dan diaktifkan, SDK iOS dan Android dapat membaca halaman riwayat situs beserta metadata lampiran biasa dan mengunduh berkas hingga 32 MiB. Unduhan memerlukan sesi terautentikasi yang aktif; URL publik berkas tidak disediakan. Penerusan privat belum didukung. Riwayat dibaca per halaman; metode ini tidak menyediakan pembaruan realtime bersama atau menandai percakapan sebagai sudah dibaca secara otomatis.

Saat bagian riwayat tertaut terbuka, widget situs secara berkala memeriksa pesan aplikasi baru serta perubahan atau penghapusan pesan yang sudah dimuat. Aplikasi seluler dapat memeriksa pembaruan melalui pemanggilan SDK secara eksplisit; SDK tidak memulai polling di latar belakang. Ini pemeriksaan berkala, bukan realtime bersama sepenuhnya. Status baca dan notifikasi setiap kanal tetap terpisah.

Mulai dengan linkedWebHistorySnapshot di iOS atau getLinkedWebHistorySnapshot di Android. Simpan mutationCursor terpisah dari page.nextAfter. Saat diperlukan, panggil linkedWebHistoryUpdates / getLinkedWebHistoryUpdates dengan kedua kursor dan hingga 500 ID pesan yang ditampilkan. Jika hasMutations bernilai true, muat ulang rentang yang ditampilkan dengan through, pertahankan batas halaman awal, dan sesuaikan penghapusan. Jika halaman awal kosong dan tidak memiliki nextAfter, berikan nil/null atau string kosong sebagai after: SDK memeriksa dari 0. Server lama dapat tidak memberikan mutationCursor; buang kursor setelah keluar.

Untuk menandai pesan yang terlihat di aplikasi seluler, panggil secara eksplisit markLinkedWebHistorySeen(messageIds:) di iOS atau markLinkedWebHistorySeen(messageIds) di Android. Berikan hingga 500 ID hanya untuk pesan masuk dari petugas (direction: "in") yang benar-benar ditampilkan kepada pengunjung. Pada bagian riwayat tertaut yang terbuka dan terlihat, widget situs otomatis menandai pesan yang terlihat. Ini dapat membatalkan email cadangan untuk balasan belum dibaca yang belum dikirim, tetapi tidak menarik kembali email yang sudah terkirim atau menyinkronkan penghitung belum dibaca chat SDK.

Untuk penghitung terpisah pesan riwayat situs tertaut tanpa tanda terlihat yang dikonfirmasi, aplikasi memanggil linkedWebUnreadCount() di iOS atau getLinkedWebUnreadCount() di Android. Penghitung mencakup pesan petugas yang dibuat setelah tautan dikonfirmasi dan belum ditandai terlihat. Menandai pesan yang benar-benar ditampilkan memengaruhi hasil berikutnya. Pembacaan di chat SDK utama mungkin tidak tercermin, sehingga ini bukan penghitung belum dibaca yang tepat. nil/null berarti server tidak mendukung penghitung, bukan nol. Penghitung ini terpisah dari penghitung belum dibaca utama chat SDK, tidak diperbarui otomatis di latar belakang atau melalui push, dan diminta aplikasi saat diperlukan.

Jika tautan situs–SDK tersedia dan diaktifkan di server (WEB_SDK_LINK_ENABLED, default nonaktif), snapshot gabungan kedua riwayat dapat dilihat. Chat biasa tetap tersedia dan operator tetap melihat dialog terpisah. Snapshot menampilkan pesan terbaru lebih dahulu, memakai nextCursor opak untuk halaman, serta menyertakan blok aman dan metadata lampiran biasa. unsupportedBlocks: true berarti ada konten yang tidak ditampilkan; penerusan privat tidak didukung. Unduh lampiran dengan otorisasi melalui downloadMergedHistoryAttachment.

Untuk menyimpan snapshot gabungan, gunakan versionedMergedWebHistory di iOS atau getVersionedMergedWebHistory di Android. Bandingkan linkVersion antarhalaman dan periksa secara eksplisit dengan mergedHistoryLinkVersion / getMergedHistoryLinkVersion sebelum menampilkan kembali riwayat tersimpan dan setelah melanjutkan aplikasi. Jika versinya berubah atau akses tidak dapat diverifikasi, hapus halaman, kursor, dan lampiran tersimpan; keluar akun juga membatalkannya. Tampilan gabungan tidak menyediakan realtime bersama, tidak menandai pesan telah dilihat, dan tidak memulai polling latar belakang.

Saat snapshot gabungan terbuka dan terlihat, widget secara berkala memeriksa perubahan dan menawarkan pembaruan manual. Sinyal ini bersifat best-effort, bukan antrean peristiwa yang terjamin atau realtime; dialog operator tetap terpisah.

Di aplikasi seluler, panggil observableMergedWebHistory di iOS atau getObservableMergedWebHistory di Android untuk halaman pertama dan simpan updatesBaseline opaknya. Jika tidak ada, server tidak mendukung pemeriksaan ini. Saat diperlukan, panggil mergedWebHistoryChanges / getMergedWebHistoryChanges dengan baseline tersebut dan hingga 500 ID pesan yang ditampilkan. hasNew menunjukkan pesan baru dan hasChanged menunjukkan perubahan atau penghapusan di antara ID yang dikirim; respons tidak berisi isi pesan. Pemeriksaan ini bersifat best-effort dan dapat melewatkan perubahan yang dikomit secara bersamaan; nilai false tidak menjamin snapshot terbaru. Muat ulang riwayat saat data terkini diperlukan. Bandingkan linkVersion dengan snapshot dan hapus halaman, kursor, serta lampiran jika berbeda atau akses tidak dapat diverifikasi. Setelah pembaruan, ambil halaman pertama dengan baseline baru. SDK tidak memulai polling latar belakang.

Chat adalah saluran web bot yang dilihat dari ponsel. Pesan, kotak masuk operator, dan pemicu otomatisasinya sama.

  • Riwayat dibaca per halaman menggunakan kursor, maksimal 50 pesan per halaman. direction dilihat dari sisi pelanggan: in berarti pesan dari operator atau bot.
  • Mengirim memakai ID pesan buatan pelanggan dan menjawab “masuk antrean”. Itu berarti diterima untuk dikirim, belum tentu sudah sampai. Status pengiriman muncul lewat realtime atau saat riwayat dibaca lagi. Mengirim ulang ID yang sama dengan teks yang sama tidak membuat pesan kedua; ID yang sama dengan teks berbeda menghasilkan konflik.
  • Lampiran diunggah satu berkas per permintaan, maksimal 10 MiB. Berkas yang isinya sama dikenali melalui hash dalam bot yang sama dan menghasilkan tautan siap pakai.
  • Belum dibaca dihitung per pemasangan berdasarkan penanda bacanya sendiri, terpisah dari penanda operator. Penanda hanya dapat bergerak maju.
  • Realtime membawa pesan baru, perubahan, penghapusan, dan status sedang mengetik. Saat tersambung, server mengirim kejadian yang terlewat saat offline, maksimal 50 bingkai, lalu kejadian baru. Klien tidak memakai kursor sambungan ulang tersendiri.

Jika pemilik bot tidak mengaktifkan saluran web, semua rute chat menjawab bahwa chat tidak tersedia untuk bot itu. Tampilkan sebagai fitur yang dinonaktifkan, bukan gangguan sementara.

Konten dalam aplikasi

GET /sdk/v1/content mengembalikan konten yang sudah ditetapkan untuk pengguna: jenis, prioritas, jeda, aturan kunjungan dan frekuensi, blok, serta tampilan. Daftar kosong adalah jawaban yang normal.

Penargetan menentukan konten yang muncul. Pop-up yang aturan perangkatnya tidak mencakup seluler tidak akan dikirim ke SDK. Pop-up tanpa aturan perangkat berlaku untuk semua perangkat. Varian dipilih secara tetap untuk satu orang, sehingga pengguna anonim melihat varian yang sama sampai identify atau keluar akun menghitung ulang penempatannya.

Ada tiga catatan hasil: impression, action, dan conversion. Konten yang ditutup dengan sapuan mendapat status akhir di perangkat saja, tanpa peristiwa server, seperti pop-up yang ditutup di situs.

Token push seluler

register_push_token menyimpan token APNs atau FCM untuk pemasangan dan masa identitas saat ini. Token disimpan terenkripsi; revoke_push_token mencabutnya. Mencabut token yang tidak dikenal dianggap berhasil agar jawaban tidak dapat dipakai untuk memeriksa token milik orang lain. Informasi pemasangan ikut dalam ekspor dan penghapusan data pengguna, tetapi nilai tokennya sendiri tidak disertakan dalam ekspor.

Konfigurasi SDK menampilkan pushEnabled: true, artinya platform mendukung push seluler. Pengiriman nyata memerlukan pengaturan FCM oleh administrator server; dengan pengaturan APNs, iOS juga dapat menerima pengiriman langsung. Buat dokumen jenis Push yang sudah diterbitkan dan pilih saluran mobile_push pada siaran atau kampanye. Pemberitahuan untuk operator ruang kerja mempunyai audiens dan penyimpanan perangkat yang berbeda.

Saat pengguna keluar, server mencabut token push aktif dari masa identitas lama. Setelah pengguna baru masuk, daftarkan kembali token untuk masa baru. Push hanya dapat dikirim ke pemasangan aktif dengan token yang masih berlaku.

Kesalahan

Setiap kesalahan /sdk/v1 berupa JSON dengan satu kolom. SDK mengelompokkannya berdasarkan status HTTP:

StatusArtinyaTindakan SDK
400Data lokal salahTidak mencoba ulang; menampilkan kesalahan masukan
401Akses ditolak: masa identitas lama, token dicabut, proyek tidak dikenal, atau tiket sudah dipakaiTidak mencoba ulang dengan kredensial yang sama
404Penempatan konten tidak dikenal atau milik pengguna lainMenghapusnya sebagai penempatan yang tidak berlaku lagi
409Chat tidak tersedia atau terjadi konflik pengiriman ulangMenampilkan kesalahan tanpa mencoba ulang
413Lampiran melebihi 10 MiBMenampilkan kesalahan tanpa mencoba ulang
500, 503Gangguan sementaraMencoba ulang tindakan yang aman diulang dengan waktu tunggu

Privasi dan diagnostik

Rute SDK tidak mengembalikan data kontak mentah, dan daftar properti yang diterima dibatasi dari awal hingga akhir. Diagnostik mati secara bawaan. Jika dinyalakan, catatannya hanya memuat kode peristiwa dari daftar tetap, waktu, dan metadata angka yang sudah dibersihkan. Diagnostik tidak memuat token, pernyataan identitas, token push, tautan, isi pesan, properti, atau konten. Catatan SDK berada dalam kategori penyimpanan sdk_diagnostics, dengan masa bawaan 180 hari, dan ikut dalam penggabungan pelanggan, ekspor, serta penghapusan data.

Kontrak

Protokol SDK berbeda dari REST API pemilik bot. Token pribadi tidak berlaku untuk /sdk/v1; token pemasangan tidak berlaku untuk /api. Daftar rute OpenAPI dapat dibuka tanpa otorisasi:

GET https://alamat-server-Anda/sdk/openapi.yaml

Aturan perilaku SDK berada dalam customer-sdk/contract/behavior.md pada repositori aplikasi seluler: perubahan keadaan, urutan tindakan, batas antrean, jeda percobaan ulang, dan penanganan kesalahan. Di sebelahnya ada keterangan struktur dan batas dari server yang dibuat otomatis, serta 75 contoh uji acuan.

Skrip pembanding mengambil ulang keterangan dari salinan backend dan melaporkan perubahan yang belum tercatat dalam kontrak. Pengujian iOS, Android, dan React Native memakai contoh yang sama agar perilakunya selaras.

API dan MCP

Rute pengelolaan proyek tersedia dengan token pribadi; lihat REST API dan token. Membaca memerlukan scope customer_sdk:read dan hak customer_sdk.read pada bot. Mengubah memerlukan customer_sdk:write dan customer_sdk.write; pengaktifan dan penggantian rahasia juga memerlukan integrations.secrets. MCP menyediakan dua alat baca saja; lihat MCP.

Bacaan berikutnya