Lewati ke konten utama

Cara Menggunakan API Eduqat dengan AI Agent seperti Claude Code atau Codex

Berikan API key kamu ke AI agent beserta satu kalimat perintah untuk menyambung ke API Eduqat. Agen akan membaca dokumentasinya sendiri lalu mulai bekerja. Tidak perlu perintah terminal untuk memulai, cukup bertanya dengan bahasa biasa.

Jawaban singkat: Buka AI agent kamu, berikan API key Eduqat kamu, lalu sampaikan dalam satu kalimat untuk menyambung ke API Eduqat. Agen membaca dokumentasinya sendiri dan langsung bekerja. Setelah itu kamu cukup meminta apa yang kamu inginkan dengan bahasa biasa.

Apa yang bisa kamu lakukan

API Eduqat membuka sekolah kamu untuk apa pun yang dapat mengirim HTTP request. Memasangkannya dengan AI agent berarti kamu tidak pernah menulis request itu sendiri.

Setelah tersambung, kamu dapat bertanya seperti ada berapa self-paced course yang saya miliki, dan mana saja yang masih draft, atau meminta buatkan self-paced course bernama Intro to Design Thinking dengan tiga sesi. Agen menentukan panggilan yang diperlukan, menunjukkannya kepada kamu, lalu menjalankannya setelah kamu setujui.

Pemakaian yang umum adalah membangun course, sesi, dan materi, mendaftarkan learner serta memeriksa sertifikat, dan menarik daftar dari sekolah kamu untuk sebuah laporan.

Ini berbeda dengan AI School Assistant. Asisten tersebut berada di dalam Eduqat Dashboard dan tidak memerlukan persiapan apa pun. API digunakan untuk pekerjaan di luar dashboard, dan untuk apa pun yang ingin kamu jadikan skrip, ekspor, atau kamu ulang.

Sebelum memulai

  • API key Eduqat. Tidak ada key yang dapat dibuat sendiri dari dashboard, jadi minta ke account manager Eduqat kamu.

  • AI agent yang dapat membaca halaman web dan menjalankan perintah, misalnya Claude Code, Cursor, atau Codex.

Hanya itu daftarnya. Kamu tidak perlu bisa coding, dan tidak perlu menyentuh terminal untuk memulai.

Langkah 1: Minta API key ke account manager kamu

Hubungi account manager Eduqat kamu dan minta API key untuk sekolah kamu. Key diterbitkan per sekolah, dan tidak ada cara membuatnya sendiri dari dashboard.

Dua hal yang perlu diketahui sebelum key tersebut datang:

Key itu sendiri sudah mengidentifikasi sekolah kamu. Kamu tidak pernah mengirimkan id sekolah, id pengguna, atau peran bersamanya. Semuanya diselesaikan server berdasarkan key tersebut.

Key ini bersifat satu tingkat. Tidak ada key khusus baca saja dan tidak ada key khusus tulis, sehingga satu key memberi akses ke seluruh operasi yang disediakan API. Perlakukan seperti kata sandi.

Langkah 2: Berikan key dan satu kalimat kepada agen

Buka agen kamu lalu serahkan keynya. Kamu dapat melampirkan key tersebut sebagai berkas atau menempelkannya ke dalam pesan, tergantung dukungan agen kamu.

Lalu kirim ini.

Sambungkan ke API Eduqat di https://developers.eduqat.com/AGENTS.md menggunakan API key yang saya berikan. Tunjukkan setiap panggilan kepada saya sebelum dijalankan.

Hanya itu persiapannya. Agen membaca panduan Eduqat untuk AI agent, menemukan spesifikasi terbaca mesin yang ditautkan dari sana, melakukan satu panggilan percobaan untuk memastikan keynya berfungsi, lalu memberitahukan apa yang ditemukannya.

Mengarahkan agen ke https://developers.eduqat.com/docs juga berhasil. Agen akan menemukan jalannya ke panduan yang sama dari sana.

Langkah 3: Sampaikan keinginan kamu

Begitu agen melaporkan koneksinya berhasil, berhentilah memikirkan endpoint dan jelaskan saja pekerjaannya.

Ada berapa self-paced course yang saya miliki, dan mana saja yang masih draft?
Buatkan self-paced course bernama "Intro to Design Thinking" dengan 3 sesi. Setiap sesi berisi satu materi video. Gunakan URL placeholder untuk videonya.

Membaca maupun menulis data berjalan dengan cara yang sama. Agen menentukan panggilan yang diperlukan, meminta izin sebelum setiap panggilan, lalu memberitahukan apa yang dikerjakannya.

Dari sana kamu dapat melanjutkan di percakapan yang sama. Meminta agen mengubah jawabannya menjadi spreadsheet, atau merapikan duplikat yang ditemukannya, adalah permintaan lanjutan yang wajar.

Langkah 4: Pastikan agen benar-benar membaca panduannya

Langkah inilah yang paling sering dilewati, dan dari sinilah jawaban yang keliru berasal.

Perhatikan tool call milik agen. Sebelum ada panggilan API, kamu semestinya melihat agen mengambil panduannya, kurang lebih seperti ini.

WebFetch(domain=developers.eduqat.com, url=/AGENTS.md)

Jika tidak ada pengambilan sama sekali dan agen langsung menyusun request, berarti agen menebak dari data latihnya, bukan membaca spesifikasi yang berlaku sekarang. Hentikan dan sampaikan hal itu.

Fetch https://developers.eduqat.com/AGENTS.md sebelum melakukan apa pun.

Jika akan sering digunakan

Semua yang di atas sudah cukup untuk pekerjaan sekali jalan. Dua langkah tambahan berikut membuat pekerjaan berulang lebih aman dan lebih cepat. Keduanya tidak wajib.

Jauhkan key dari riwayat percakapan. Menempelkan key ke dalam pesan berarti key tersebut tersimpan di riwayat percakapan itu. Menyimpannya sebagai environment variable membuat agen dapat memakainya tanpa nilainya pernah muncul di percakapan.

Di macOS, tambahkan baris ini ke ~/.zshrc. Di Linux, tambahkan ke ~/.bashrc.

export EDUQAT_API_KEY="YOUR_API_KEY"

Lalu muat ulang shellnya dan pastikan nilainya sudah terisi.

source ~/.zshrc echo $EDUQAT_API_KEY

Di Windows, atur sekali melalui Command Prompt atau PowerShell, lalu buka terminal baru agar perubahannya berlaku.

setx EDUQAT_API_KEY "YOUR_API_KEY"

Setelah itu minta agen menggunakan $EDUQAT_API_KEY, bukan memberikan keynya secara langsung.

Buat setiap sesi baru langsung siap. Buat satu folder khusus pekerjaan Eduqat dan letakkan berkas instruksi proyek di dalamnya. Setiap sesi berikutnya yang kamu buka di folder itu sudah siap sebelum kamu mengetik apa pun.

Di Claude Code berkasnya bernama CLAUDE.md. Minta agen kamu membuatnya dengan isi berikut.

# Eduqat integration  When I ask you to do anything with Eduqat: 1. Fetch https://developers.eduqat.com/AGENTS.md if you have not already this session. 2. Fetch https://developers.eduqat.com/openapi.json for endpoint schemas. 3. Use the env var $EDUQAT_API_KEY for auth, sent as the x-api-key header. 4. Base URL is https://public-api.eduqat.com unless I say otherwise. 5. Always show me each command before running it.

Codex, Cursor, dan agen lain masing-masing memiliki berkas konteks atau instruksinya sendiri, jadi periksa dokumentasi agen kamu untuk mengetahui letaknya. Isinya selalu tiga hal yang sama: URL https://developers.eduqat.com/AGENTS.md, nama variabel EDUQAT_API_KEY, dan nama header x-api-key.

Memeriksa sendiri sebuah key. Jika kamu ingin memastikan sebuah key sebelum menyerahkannya ke apa pun, jalankan perintah ini di terminal lalu ganti YOUR_API_KEY.

curl -sS "https://public-api.eduqat.com/manage/v1/courses?limit=1" -H "x-api-key: YOUR_API_KEY"

JSON yang memuat array items berarti keynya berfungsi. 401 berarti keynya salah, dan 403 berarti keynya benar tetapi tidak memiliki izin untuk rute tersebut.

Jaga keamanan key

Key ini memberi akses ke seluruh operasi pada sekolah kamu, jadi aturan umumnya berlaku tanpa pengecualian.

Jangan pernah memasukkannya ke git. Jika agen kamu menuliskan key tersebut ke berkas .env, pastikan berkas itu tidak ikut tersimpan ke git.

Jangan pernah menempelkannya ke percakapan bersama, tiket, atau dokumen yang dapat dibaca orang lain. Sesi pribadi dengan agen kamu sendiri tidak masalah, tetapi apa pun yang dapat dibuka orang lain tidak.

Jika kamu menduga keynya bocor, segera beri tahu account manager kamu dan minta key yang baru.

Pemecahan masalah

Masalah

Kemungkinan penyebab

Solusi

401 Unauthorized

Keynya tidak ada atau salah

Pastikan agen menerima keynya secara utuh, tanpa baris baru atau spasi di ujung. Jika kamu memakai environment variable, buka terminal baru agar nilainya terbaca

403 Forbidden

Keynya benar tetapi tidak memiliki izin untuk rute tersebut

Minta account manager kamu memeriksa cakupan keynya

403 padahal panggilan yang sama berhasil di tempat lain

Sebagian HTTP client mengirim user agent bawaan yang diblokir

Minta agen kamu menyetel header User-Agent sendiri pada requestnya

404 pada id yang baru saja dibuat

Sumber dayanya milik sekolah lain

Id dari sekolah lain membalas 404, bukan 403. Pastikan keynya milik sekolah yang kamu maksud

Agen mengarang nama field

Agen tidak membaca spesifikasinya

Sampaikan: "Fetch openapi.json dan periksa request body untuk endpoint tersebut"

Agen memakai autentikasi Bearer

Agen memilih pola yang paling umum

Sampaikan: "Autentikasinya header x-api-key, bukan bearer"

400 dengan pesan tentang kolom yang tidak ada

Parameter paginasi dikirim ke endpoint yang tidak menerimanya

Hanya daftar course yang menerima limit dan page. Minta agen membuangnya di endpoint lain

400 PRICE_NOT_SET saat menerbitkan

Coursenya belum memiliki harga

Pasang harganya lebih dahulu, atau biarkan coursenya tetap draft selama kamu mencoba

400 INVALID_COURSE_STATUS

Nilai statusnya keliru

Nilai yang berlaku adalah draft, public, dan deactive. Tidak ada published

Quiz atau survei tidak memiliki pertanyaan

Alur dua langkahnya terlewat

Materi quiz dan survei memerlukan entitas survei dibuat lebih dahulu, baru ditautkan. Arahkan agen ke bagian quiz pada panduannya

FAQ

Apakah benar saya tidak perlu menyiapkan apa pun?

Untuk pekerjaan sekali jalan, benar. Berikan keynya dan satu kalimat, sisanya ditangani agen. Environment variable dan berkas proyek disediakan untuk kamu yang akan sering kembali mengerjakan ini.

Di mana saya mendapatkan API key?

Dari account manager Eduqat kamu. Tidak ada key yang dapat dibuat sendiri dari dashboard, jadi minta account manager kamu menerbitkannya untuk sekolah kamu.

Apakah saya perlu bisa coding?

Tidak. Kamu menyampaikan keinginan dengan bahasa biasa dan agen yang menulis requestnya. Satu-satunya alasan membuka terminal adalah pengamanan tambahan yang dijelaskan di atas.

Apakah aman menempelkan key saya ke dalam percakapan?

Di sesi pribadi kamu sendiri, aman, dengan satu catatan: keynya tetap tersimpan di riwayat percakapan tersebut. Jika riwayat itu dapat dilihat orang lain, atau kamu akan sering memakai keynya, simpan sebagai environment variable.

Apakah ada key khusus baca saja untuk keperluan laporan?

Tidak ada. Keynya satu tingkat dan memberi akses ke seluruh operasi yang disediakan API, sehingga tidak ada varian baca saja yang lebih aman. Jika kamu hanya ingin membaca, sampaikan hal itu pada pesan pertama dan periksa setiap panggilan sebelum menyetujuinya.

Agen apa saja yang dapat digunakan?

Agen mana pun yang dapat membaca halaman web dan menjalankan perintah. Panduan penyiapan milik Eduqat mencakup Claude Code, Cursor, dan Codex, dan cara yang sama berlaku untuk agen lainnya.

Apakah ada lingkungan percobaan?

Eduqat menerbitkan alamat sandbox di samping alamat produksinya, tetapi panduannya meminta kamu memastikan dahulu sebelum mengandalkannya. Tanyakan ke account manager kamu, jangan diasumsikan sudah aktif untuk sekolah kamu.

Mengapa agen kadang keliru menyebut nama field?

Karena agen menebak alih-alih membaca spesifikasinya. Spesifikasi yang terbaca mesin di openapi.json adalah acuan yang benar untuk request body. Minta agen memeriksanya untuk endpoint yang sedang dipanggil.

Apakah agen dapat menerbitkan course untuk saya?

Bisa, tetapi penerbitan memiliki aturannya sendiri. Sebuah course memerlukan harga sebelum dapat dijadikan publik, dan nilai statusnya adalah public, bukan published. Membiarkan course tetap draft selama kamu mencoba menghindari keduanya.

Bagaimana saya tahu agennya tidak mengarang?

Perhatikan pengambilan panduannya sebelum ada panggilan API, dan baca setiap perintah sebelum kamu menyetujuinya. Agen yang langsung menyusun request tanpa mengambil apa pun sedang bekerja dari ingatan.

Artikel terkait

Masih perlu bantuan?

Untuk apa pun yang menyangkut keynya, termasuk 403 yang tidak kunjung hilang, hubungi account manager kamu. Untuk path terdokumentasi yang membalas 404, atau apa pun yang terlihat seperti bug, hubungi kami melalui tombol live chat di pojok kanan bawah layar dan kami akan menelusurinya bersama kamu. Dokumentasi lengkap untuk developer ada di https://developers.eduqat.com/docs.

Apakah pertanyaan Anda terjawab?