Codex · III

Kunci API

Kunci API memungkinkan Anda memanggil endpoint checkout dan status dari kode Anda sendiri, tanpa tombol beli. Anda hanya membutuhkannya jika Anda membangun checkout atau integrasi server Anda sendiri; jika Anda menempel tombol beli, Anda dapat melewati ini sama sekali.

Saat Anda membutuhkan kunci

Tombol beli bekerja tanpa kunci sama sekali — ia berbicara dengan endpoint publik yang scoped proyek. Kunci adalah untuk jalur lain: panggilan yang Anda buat dari server Anda sendiri, di mana Anda membuat checkout atau membaca status transaksi dalam kode. Kunci berada di bawah tab API Keys proyek Anda.

Tab Kunci API. Kosong sampai Anda membuat kunci pertama Anda.

Buat kunci

Klik Create key, berikan nama yang akan Anda kenali nanti — biasanya di mana itu berjalan, seperti "Production server" — dan klik Generate key. Nama hanyalah label untuk Anda; itu tidak mengubah apa yang dapat dilakukan kunci (kunci scoped ke proyek ini).

Beri nama kunci untuk di mana itu akan hidup, kemudian buatnya.

Salin sekali

Kunci ditampilkan sekali, tepat setelah Anda membuatnya. Dimulai dengan cmk_. Salin sekarang dan simpan di tempat yang aman — kami hanya menyimpan hash, jadi kami tidak dapat menunjukkannya kepada Anda lagi. Hilangkan dan Anda cukup membuat yang baru dan menghapus yang lama.

Ini adalah satu-satunya waktu kunci lengkap ditampilkan. Salin sebelum Anda menutup.

Perlakukan kunci seperti kata sandi. Gunakan hanya dari kode server-side, kirimkan di header Authorization sebagai token pembawa, dan jangan pernah letakkan di halaman web, repo publik, atau apa pun yang dikirim ke browser pembeli. Siapa pun dengan kunci dapat bertindak untuk proyek Anda.

Gunakan, daftar, dan cabut

Kunci yang disimpan dicantumkan berdasarkan nama, awalan bertopeng, dan tanggal dibuat. Anda tidak pernah melihat kunci lengkap lagi — awalan cukup untuk membedakannya. Ikon tempat sampah mencabut kunci dengan segera: kode apa pun yang masih menggunakannya mulai ditolak, jadi putar dengan membuat kunci baru terlebih dahulu, menerapkannya, kemudian menghapus yang lama.

Setiap kunci menunjukkan awalan bertopeng dan tanggal dibuat; ikon tempat sampah mencabutnya.

Untuk apa yang dapat Anda panggil dengan kunci — membuat checkout dari kode Anda sendiri, menangani acara, dan menanyakan status — lihat Menggunakan API.

Siap merangkainya?

Tingkat gratis mencakup sebagian besar situs dan tidak pernah meminta kartu.