Beranda Dokumentasi Marketplace Fitur Paket Kepatuhan Masuk

Dokumentasi

Semua yang kamu butuhkan untuk mengintegrasikan Caputchin, membuat game, dan mengelola akunmu. Dokumentasi disusun per topik, dan setiap halaman ditulis dalam satu mode Diátaxis. Setiap halaman bisa diambil sebagai markdown mentah di /docs/raw/<slug> untuk agen AI, dan indeks llms.txt mencantumkan setiap jalur kanonis.

Permisif, terbuka, minimal

Filosofi kami

Satu sikap, dilihat dari tiga sisi: kami permisif soal apa yang bisa kamu lakukan, terbuka soal cara kami melakukannya, dan minimal soal apa yang kami simpan. Kami membatasi pengalaman terkelola dan seberapa jauh sebuah perubahan menyebar, tidak pernah kemampuan dasarnya, dan kami tidak menyimpan apa pun tentang pengunjungmu karena tidak ada yang kami butuhkan.

Baca filosofi kami

Memulai

Buat akun dan kunci situs pertamamuTutorialMasuk, buka tim Personal-mu, dan cetak public key serta secret yang akan kamu pakai di mana-mana.
Tambahkan widget ke situsmuTutorialTambahkan widget ke formulir kontak React-mu, pastikan sebuah verifikasi sungguhan di dasbor, lalu paksakan di backend Node-mu.
Tambahkan game dari marketplaceTutorialJelajahi marketplace, pasang sebuah game di kunci situs-mu, jadikan wajib, lalu tukar satu elemen agar pengunjung menuntaskan tantangan game sungguhan yang bisa dimainkan.

Kunci situs

IkhtisarPenjelasanApa itu kunci situs, cara membuatnya, dan pengaturan yang mengaturnya, dari nama dan status hingga rotasi secret dan penghapusan.
KeamananPenjelasanCara menyetel perlindungan sebuah key, dan cara memilih antara lebih kuat dan lebih cepat.
Game dan gerbang gamePenjelasanDaftarkan game marketplace yang boleh dipakai sebuah kunci situs, dan wajibkan pengunjung memainkan satu untuk lolos verifikasi.
Statistik dan sesiPenjelasanCara membaca funnel verifikasi, volume, dan waktu sebuah key, apa yang diberitahukan tiap grafik, dan apa yang harus dilakukan.

Panduan integrasi

Integrasi sisi klienPanduan praktisCara menaruh widget di halamanmu, lewat tag script CDN atau impor npm, dan mana yang dipakai.
Integrasi aplikasi selulerPanduan praktisSematkan widget di WebView iOS, Android, React Native, atau iframe-peramban, dan jembatani token terverifikasi kembali ke kodemu.
Integrasi sisi serverPanduan praktisAmbil caputchin-token dari sebuah kiriman dan pastikan dengan /siteverify sebelum memercayai permintaannya.
Contoh integrasi frontendPanduan praktisPasang widget di HTML murni, React, Vue, Svelte, Angular, dan Next.js. Elemennya sama di mana-mana.
Contoh integrasi backendPanduan praktisPanggilan /siteverify di Node, Python, PHP, Go, Ruby, .NET, dan curl. Tak ada SDK untuk dipasang.

Panduan migrasi

Migrasi dari reCAPTCHAPanduan praktisTukar reCAPTCHA dengan Caputchin dengan perubahan minimal: bentuk dua-bagian yang sama (widget klien plus verify sisi-server) memetakan hampir satu-lawan-satu, inilah sebelum-dan-sesudah persis untuk tiap potongan.
Migrasi dari hCaptchaPanduan praktisTukar hCaptcha dengan Caputchin dengan perubahan minimal: bentuk widget-klien-plus-verify-server yang sama memetakan hampir satu-lawan-satu, inilah sebelum-dan-sesudah persis untuk tiap potongan.
Migrasi dari Cloudflare TurnstilePanduan praktisTukar Cloudflare Turnstile dengan Caputchin dengan perubahan minimal: bentuk widget-klien-plus-verify-server yang sama memetakan hampir satu-lawan-satu, dan seperti Turnstile hasilnya adalah lolos/gagal yang bersih, inilah sebelum-dan-sesudah.

Kustomisasi game

Kustomisasi game yang dimainkan pengunjungmuPanduan praktisDaftarkan game marketplace, setel bahasa, skin, dan konfigurasinya, dan kelola pembaruan serta penghapusan, semua dari dasbor.
Konfigurasi gameplay sebuah gamePanduan praktisSetel opsi gameplay yang dipaparkan game, seperti tingkat kesulitan, di tab Konfigurasi; tersedia di setiap paket.
Kustomisasi bahasa sebuah gamePanduan praktisTimpa string terjemahan game di tab Bahasa, dikelompokkan per bahasa; tersedia dari paket Alpha ke atas.
Kustomisasi skin sebuah gamePanduan praktisTimpa warna dan aset visual game di tab Skin, dikelompokkan per mode (terang, gelap, atau keduanya); tersedia dari paket Alpha ke atas.
Game kustomPenjelasanDaftarkan dan hosting game-mu sendiri alih-alih game marketplace, dengan artefak putar-ulang agar ia bisa menggerbang verifikasi.

Kustomisasi widget

Bagaimana widget menyelesaikan bahasa dan skin-nyaPenjelasanBagaimana shell widget memilih bahasa dan skin terang atau gelapnya, dan bagaimana itu mengikuti game saat satu dipasang.
White-label widgetPanduan praktisGanti kata, warna, dan tautan shell widget dengan milikmu sendiri, fitur jenjang-Apex yang ditulis di dasbor.
Beri gaya widget dengan CSSReferensiBeri gaya shell widget dari stylesheet-mu sendiri, dengan selektor ::part() dan properti kustom --cpt-skin, plus referensi setiap part dan variabel.

Verifikasi terhosting

Verifikasi tanpa backendPenjelasanApa itu verifikasi terhosting, untuk siapa ia, dan bagaimana Caputchin memverifikasi sebuah kiriman dan meneruskannya ke webhook atau email agar kamu tak pernah menjalankan backend.
Siapkan verifikasi terhosting dengan kotak masuk ujiTutorialSambungkan verifikasi terhosting dari ujung ke ujung dengan kotak masuk webhook.site gratis, saksikan sebuah kiriman terverifikasi sungguhan tiba, lalu arahkan ke tujuanmu sendiri.
Statistik verifikasi terhostingPenjelasanBaca permukaan pengiriman untuk verifikasi terhosting, apa makna tiap ubin dan garis, dan apa yang diberitahukan lonjakan kegagalan.
Referensi payload webhookReferensiPermintaan persis yang diterima sebuah webhook verifikasi-terhosting, setiap field di body, dan header yang dikirim Caputchin.

Manajemen akun

Apa yang berada di tingkat akunReferensiApa yang berada di tingkat akun, dari masuk dan access token hingga penagihan dan kursi.
Pengaturan akunPanduan praktisKelola email-mu, sesi aktif, akses dukungan, dan access token akun dari halaman pengaturan akun.
Personal access tokenReferensiToken cpt_pat_ tingkat-akun untuk API, MCP, dan Terraform, apa yang bisa dan tak bisa ia lakukan, bagaimana ia dibanding Troop Access Token, dan cara melacak penggunaannya.
PenagihanPanduan praktisPilih paket, sesuaikan kursi, kelola kartu dan faktur, dan batalkan atau lanjutkan, semua dari halaman penagihan.

Tim

Apa itu timReferensiApa itu tim dan apa yang dimilikinya, dari kunci situs hingga kustomisasi game hingga anggota yang kamu undang.
Buat tim bersama pertamamuTutorialDirikan sebuah tim bersama dan undang tiga rekan tim, masing-masing dengan persis izin yang dibutuhkan perannya, mengikuti BananaSeed saat ia membangun sebuah kelompok.
Izin dan cakupanReferensiEmpat izin yang bisa dipegang anggota tim (baca, buat, edit, kelola) dan cakupan kunci situs yang membatasinya.
KursiReferensiBagaimana kumpulan kursi bersama akun dipakai oleh anggota tim dan token tim, dan apa yang gratis.
Troop Access TokenReferensiKredensial layanan yang tercakup ke sebuah tim, dengan izin yang sama yang dimiliki seorang anggota, untuk otomasi yang sebaiknya tak memakai akses seseorang.
Penggantian timPenjelasanBagaimana sebuah tim menyetel kustomisasi game dan white-label sekali sebagai baseline yang diwarisi setiap kunci situs di dalamnya, dan bagaimana sebuah key menimpa sebuah pengecualian.
Statistik timPenjelasanFunnel verifikasi seluruh-tim, volume, kegagalan, dan waktu yang digulung lintas setiap kunci situs di tim, plus tampilan pengiriman, dan di mana menggali ke satu key.

Log audit

Bagaimana log audit bekerjaPenjelasanCatatan keterlacakan Apex tentang siapa mengubah apa dan kapan, disimpan di tiga tingkat independen, dengan bagaimana entri terbaca, cara menyaring dan mengekspor, dan berapa lama ia bertahan.
Log audit akunReferensiSetiap aksi yang dicatat log audit tingkat-akun, berdasarkan nama, dan di mana menemukannya.
Log audit timReferensiSetiap aksi yang dicatat log audit tingkat-tim, berdasarkan nama, termasuk anggota, pengaturan tim, dan penghapusan kunci-situs.
Log audit kunci-situsReferensiSetiap aksi yang dicatat log audit tingkat-kunci-situs, berdasarkan nama, lintas siklus hidup dan konfigurasi satu key.

Otomasi

Kelola Caputchin dari APIPanduan praktisAutentikasi dengan personal access token dan kemudikan satu management API langsung lewat HTTP, dengan contoh kerja dan tautan ke referensi lengkap.
Pakai server MCPPanduan praktisHubungkan agen AI ke Caputchin lewat server MCP, autentikasi ia dengan access token, dan kemudikan management API dalam bahasa alami, dengan contoh kerja.
Referensi alat MCPReferensiSetiap alat MCP Caputchin, apa yang dilakukannya, dan izin yang harus dipegang token-nya, dikelompokkan per area.
Pakai Terraform atau OpenTofuPanduan praktisKelola Caputchin sebagai infrastructure-as-code dengan penyedia resmi, yang berfungsi identik di Terraform dan OpenTofu, dengan contoh kerja dan tautan ke referensi registry lengkap.

Pengembangan game kustom

Jalankan game-mu sendiriPenjelasanApa itu pengembangan game kustom, dua cara mengirim game-mu sendiri (slot manual atau iframe swahosting), dan apa yang ditambahkan dasbor (skema, preset, dan artefak putar-ulang yang membiarkan sebuah game kustom menggerbang).
Kemudikan verifikasi sendiri dengan mode manualTutorialMode manual membiarkan kodemu sendiri mengemudikan siklus hidup verifikasi. Ia ada di dua elemen (widget checkbox dan host game) dengan pekerjaan berbeda; halaman ini membangun keduanya dan menunjukkan kapan memakai masing-masing.
Bangun game swahostingTutorialBangun bundel game ber-sandbox dengan game SDK, hosting sendiri, arahkan widget ke ia dengan game-src, dan hasilkan trace deterministik yang diputar-ulang server.
Buat game kustom bisa-digerbangTutorialUnggah artefak putar-ulang headless untuk game swahosting-mu agar server bisa menurunkan-ulang vonis, langkah yang membiarkan game kustom memenuhi gerbang game.
Skema dasbor game kustomReferensiBagaimana sebuah game kustom mendeklarasikan bidang yang bisa dikustomisasi di dasbor, per sumbu, karena ia tak punya manifest, dan tipe bidang yang diterima tiap sumbu.

Pengembangan game marketplace

Kirim game ke marketplacePenjelasanApa itu pengembangan game marketplace, potongan yang terlibat (SDK, manifest, kontrak putar-ulang, kit engine opsional), dan bagaimana mereka cocok bersama dari kode ke game yang diterbitkan, bisa-diputar-ulang yang bisa disematkan siapa pun.
Bangun game marketplaceTutorialBangun game Caputchin dari folder kosong: pasang SDK, daftarkan factory, render dari konteks per-ronde, rekam trace, dan bundel ia untuk iframe ber-sandbox.
Referensi game SDKReferensiPermukaan @caputchin/game-sdk lengkap yang menjadi dasar penulisan penulis game, fungsi register, jembatan push-only, konteks per-ronde, dan tipe preset.
Manifest caputchin.jsonReferensiSetiap bidang manifest caputchin.json yang mendeskripsikan game marketplace, blok marketplace, penunjuk distribusi, artefak run putar-ulang, blok preset, dan berkas split .caputchin.
Kontrak putar-ulangReferensiKontrak run/seed/verdict wajib yang membuat sebuah game bisa-diputar-ulang, apa yang diterima dan dikembalikan fungsi run, bagaimana seed mengikat trace ke satu ronde, dan bagaimana server memutarnya-ulang.
engine-kit (opsional)TutorialKit penulisan opsional yang menghasilkan run putar-ulang yang sesuai dari reducer biasa, menangani determinisme, loop langkah-tetap, pengkodean trace, dan pemeriksaan-diri lokal untukmu.
Terbitkan ke marketplaceTutorialTag repo-mu, biarkan pengindeks menemukan dan memin-nya, pahami pemeriksaan-diri putar-ulang, dan otomasi penerbitan-ulang dari CI pada setiap rilis.
Perbaiki kegagalan terbit marketplacePanduan praktisTemukan kode galatmu di bawah dan ikuti langkahnya. Tiap perbaikan adalah satu putaran sunting-dan-coba-ulang; kamu tak perlu meminta kami memeriksa-ulang apa pun.
Referensi galat terbitReferensiSetiap kode galat yang bisa dipancarkan jalur terbit marketplace, dengan pemicu dan di mana menemukan perbaikannya.

Memahami Caputchin

Filosofi kamiPenjelasanSikap Caputchin lintas produk. Kami permisif dengan kemampuan, terbuka dengan kode kami, dan minimal dengan data. Kami menggerbang pengalaman terkelola dan seberapa jauh sebuah perubahan berjalan, tak pernah hal mentah yang bisa kamu lakukan.
Proof of workPenjelasanMengapa Caputchin membuat peramban melakukan sedikit komputasi sebelum menerbitkan token, dan bagaimana itu menaikkan ongkos penyalahgunaan.
InstrumentasiPenjelasanBagaimana Caputchin memeriksa bahwa sebuah tantangan dipecahkan peramban sungguhan, bukan skrip yang berpura-pura jadi satu.
Anti-curang gamingPenjelasanBagaimana game lebih dari sekadar tantangan. Sebuah sistem anti-curang berlapis yang menyiapkan tiap ronde di server, menjalankannya ber-sandbox di peramban, dan memverifikasinya ulang lewat putar-ulang deterministik.
Bagaimana Caputchin men-sandbox gamePenjelasanSetiap ukuran isolasi di sekitar game Caputchin: iframe origin-opaque, satu token sandbox-nya, Content-Security-Policy inline yang ketat, hashing integritas, dan bagaimana semua itu hidup berdampingan dengan CSP yang kamu setel di halamanmu sendiri.

Referensi

Metode dan event widgetReferensiSetiap metode yang bisa kamu panggil pada elemen widget Caputchin dan setiap event yang mereka pancarkan, dengan payload persis masing-masing, elemen mana yang memaparkannya, dan kapan ia sah.
Referensi skema kustomisasiReferensiModel tipe-bidang dan preset bersama di balik setiap permukaan yang bisa dikustomisasi, tipe bidang yang diizinkan tiap sumbu, nilai yang diterima masing-masing, dan bagaimana skema dan preset didefinisikan serta diselesaikan.
API Manajemen
API Runtime
TerraformManage site keys, troops, and settings as code with the Terraform provider.
OpenTofuThe Caputchin provider on the OpenTofu registry.
@caputchin/widgetAuto-generated type reference for the browser widget package: the custom elements, their config, and their events.
@caputchin/game-sdkAuto-generated type reference for the game authoring package: register, the Bridge, and the caputchin.json manifest types.
@caputchin/replay-contractAuto-generated type reference for the run / seed / verdict replay contract every replayable game implements.
@caputchin/engine-kitAuto-generated type reference for the optional reducer-to-run authoring kit: the fixed-step replay loop and the default trace codec.
@caputchin/determinismAuto-generated type reference for the determinism primitives: fdlibm transcendental math, the Math swap, seeded RNG, and the make-deterministic environment helpers.
@caputchin/replay-selfcheckAuto-generated type reference for the shared determinism + smoke self-check: the prober that flags ambient access, native-trig divergence, and run-to-run drift.
@caputchin/replay-wasmAuto-generated type reference for the WebAssembly trace codec helpers used by replayable WASM games.
@caputchin/preset-kaplayAuto-generated type reference for the KAPLAY engine on-ramp: the deterministic headless harness for KAPLAY games.
@caputchin/preset-melonjsAuto-generated type reference for the melonJS engine on-ramp: the deterministic headless harness for melonJS games.
@caputchin/preset-phaserAuto-generated type reference for the Phaser engine on-ramp: the deterministic headless harness for Phaser games.
@caputchin/mcpAuto-generated type reference for the stdio MCP adapter that proxies the management API tool catalogue.

Sumber daya

Repositori SDKSource for the @caputchin SDK and widget packages.
Repositori GamesOpen-source first-party games: the official Caputchin Core Pack.
Repositori Penyedia TerraformSource for the Caputchin Terraform and OpenTofu provider.