Lewati ke konten utama

Panduan Cepat

Panggilan API Cognivo pertama Anda​

Cognivo Developer API memungkinkan kode Anda sendiri mengajukan pertanyaan on-chain yang sama seperti yang bisa Anda ajukan di dApp dan di Cognivo Chat. Halaman ini menempuh jalur terpendek untuk itu: buat proyek, buat key, jalankan satu panggilan sungguhan, baca jawabannya.

Kapan menggunakannya​

Gunakan API ketika Anda ingin pemeriksaan token, dompet, atau Liquidity berada di dalam sesuatu yang sedang Anda bangun, misalnya bot trading, dasbor internal, tugas peringatan, atau layanan backend, alih-alih mengklik dApp setiap kali. Jika Anda hanya ingin menjalankan pemeriksaan secara manual, dApp dan Chat sudah melakukannya dan Anda tidak memerlukan key.

Di mana menemukannya​

Masuk ke dApp, buka Account di sidebar, lalu pilih Developers. Pengunjung yang belum masuk hanya melihat layar pengantar, jadi masuk terlebih dahulu. Semua hal di halaman ini terjadi pada satu layar tersebut.

Buat proyek, lalu key​

Sebuah proyek mengelompokkan API key Anda beserta penggunaannya, jadi mulailah dari sana.

  1. Pilih New project untuk membuka formulir singkat di bawah pemilih proyek.
  2. Ketik sebuah nama di Project name agar Anda bisa membedakan proyek Anda nanti.
  3. Pilih Create untuk menambahkan proyek, atau Cancel untuk menutup formulir tanpa menyimpan.
  4. Pilih Create live key untuk membuat kunci bagi proyek itu, lalu kirimkan bersama permintaan dari kode Anda sendiri.
Kontrol proyek di halaman Developers, tempat Anda menyiapkan sebuah proyek sebelum membuat kunci.Perbesar gambar

Nama proyek hanyalah label untuk Anda sendiri. Nama itu tidak muncul dalam permintaan Anda dan Anda dapat membuat lebih dari satu proyek, sampai batas yang ditampilkan di halaman.

Ketika Anda memilih Create live key, Cognivo menampilkan key lengkap tepat satu kali, di dalam dialog dengan tombol salin. Salin saat itu juga dan simpan di tempat yang aman. Setelahnya halaman hanya menampilkan versi tersamar, yaitu prefiks dan empat karakter terakhir, karena Cognivo menyimpan key dalam bentuk yang tidak bisa dibaca kembali. Jika Anda kehilangan sebuah key, atau menduga key itu bocor, gunakan Rotate atau Revoke pada baris key tersebut. Key lama langsung berhenti bekerja.

Setiap key juga membawa Permissions, yang mengatur apa saja yang boleh dipanggilnya: Intelligence, Security, dan Liquidity. Berikan sebuah key hanya izin yang benar-benar dibutuhkannya. Contoh di bawah membutuhkan Liquidity.

Dua tombol lain berada di kartu yang sama. Top up credits membawa Anda ke halaman Billing. Enterprise access membuka alur Support, dan itulah satu-satunya jalur yang melibatkan pengajuan permintaan, untuk harga khusus atau batas yang lebih tinggi. Sebuah key live biasa tidak memerlukan persetujuan dan langsung bekerja begitu Anda membuatnya.

Jalankan contoh panggilan​

Buka tab Quickstart. Tab itu memuat contoh yang berfungsi dan bisa Anda salin lalu jalankan tanpa menulis apa pun sendiri.

Tab Quickstart di halaman Developers, tempat Anda menyalin contoh panggilan yang siap pakai.Perbesar gambar

Kartu Test keys vs live keys menjelaskan perbedaannya. Test key melakukan panggilan yang aman dengan batas ketat, yang cocok untuk tahap perakitan. Live key melakukan panggilan sungguhan yang dibebankan dari saldo kredit Cognivo Anda. Kartu Test a live endpoint kemudian memberikan lima langkah bernomor beserta perintahnya, lengkap dengan ikon salin.

Perintah tersebut adalah pemeriksaan Liquidity sungguhan pada kontrak Base sungguhan:

curl -X POST 'https://api.cognivolabs.io/v1/api/intel/liquidity' \
  -H 'X-API-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"chain":"base","address":"0xe2b1dc2d4a3b4e59fdf0c47b71a7a86391a8b35a"}'

Panggilan yang sama dari JavaScript atau TypeScript:

const res = await fetch("https://api.cognivolabs.io/v1/api/intel/liquidity", {
  method: "POST",
  headers: {
    "X-API-Key": process.env.COGNIVO_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ chain: "base", address: "0xTOKEN_CONTRACT" }),
});
const json = await res.json();
if (json.ok) {
  console.log(json.data);
  console.log(json.meta.request_id);
} else {
  console.error(json.error);
}

Apa yang dikembalikan​

Setiap endpoint menjawab dengan amplop yang sama, seperti yang ditampilkan blok Expected response pada tab Quickstart:

{
  "ok": true,
  "data": { "identity": { "name": "...", "symbol": "..." }, "marketSnapshot": {} },
  "meta": {
    "chain": "base",
    "request_id": "capi_...",
    "credits_charged": 0,
    "generated_at": "..."
  }
}

data memuat hasilnya. meta.request_id layak dicatat, karena tim Support bisa menelusuri satu panggilan berdasarkan nilai itu. meta.credits_charged memberi tahu Anda persis berapa biaya panggilan tersebut.

Sebuah field bisa kembali kosong, tidak diketahui, atau tidak tersedia. Artinya Cognivo tidak dapat memverifikasinya dari data yang bisa dijangkau, bukan berarti tidak ada apa-apa di sana. Bacalah itu sebagai "tidak terkonfirmasi", dan jangan anggap hasil yang sunyi sebagai tanda aman. Cognivo melaporkan apa yang diperiksa dan apa yang ditemukan, dan tidak ada isi respons yang membuktikan sebuah token adalah penipuan maupun membuktikan sebuah token aman.

Panggilan yang gagal menjawab dengan ok bernilai false, sebuah kode error, dan sebuah request_id. Panggilan yang gagal tidak dikenakan biaya.

Biaya, chain, dan batas​

  • Sebagian endpoint gratis dengan key aktif mana pun. Sebagian lain dibebankan per panggilan yang berhasil dari saldo kredit Cognivo Anda. Tab Endpoints mencantumkan setiap endpoint beserta harganya dalam kredit Cognivo, atau Free jika gratis, jadi periksa di sana sebelum Anda membangun di atas sebuah endpoint.
  • Anda hanya dikenakan biaya untuk panggilan yang berhasil, dan meta.credits_charged mengonfirmasi jumlahnya. Kesalahan, timeout, dan panggilan yang diblokir tidak memakan biaya.
  • Setiap akun mendapat 5 kredit gratis per hari. Kredit itu disetel ulang pada tengah malam UTC dan dipakai sebelum kredit berbayar mana pun.
  • Saat ini API mencakup Ethereum, Base, dan BNB Chain. Sebagian endpoint mendukung lebih sedikit chain dibanding yang lain.
  • Test key dibatasi dengan ketat dan bukan tingkat produksi gratis. Setiap baris key pada tab Keys menampilkan batas yang sedang diterapkan Cognivo pada key tersebut, yang bisa lebih rendah daripada bawaan tingkatannya.
  • Key yang ditangguhkan, atau key di dalam proyek yang ditangguhkan, tidak bisa menjalankan apa pun, dan portal menampilkan alasannya.

Jaga keamanan key Anda​

Panggil API dari server, jangan pernah dari kode browser atau aplikasi mobile. Simpan key di variabel lingkungan atau pengelola rahasia, jangan pernah di repositori publik, pesan chat, atau tangkapan layar. Jika sebuah key mungkin bocor, lakukan rotate atau revoke pada tab Keys.

Langkah berikutnya​

Baca Autentikasi dan key untuk pembahasan lengkap izin dan penanganan key, Endpoint untuk mengetahui apa yang dikembalikan setiap panggilan dan berapa biayanya, serta Batas laju dan kesalahan untuk percobaan ulang dan kode kesalahan. Untuk saldo kredit dan pengisian ulang, lihat Billing dan kredit.