Kanesh
GitHub ★ Star

API

Ikhtisar API

Base URL, ID, semua endpoint utama, format respons, dan error.

Setiap contoh di dokumentasi API tersedia dalam cURL, Node.js, Go, dan Python. Pilih bahasa sekali, dan semua halaman akan mengingatnya. Kanesh tidak punya SDK yang perlu dipasang: contohnya memakai HTTP biasa.

Sebelum mulai

  • Jalankan Kanesh dengan Memulai dan buat koleksi di Studio.
  • Contoh Node.js butuh Node 18 atau lebih baru. Simpan sebagai .mjs agar await bisa dipakai di level atas.
  • Contoh Python memakai requests: pip install requests.
  • Contoh Go hanya memakai standard library.

Base URL dan ID

Instalasi lokal melayani API di http://127.0.0.1:8080. Path API diawali /api/v1. Pakai HTTPS saat Kanesh berjalan di luar mesinmu.

Path memakai ID, bukan nama. :workspace adalah ID workspace dan :collection adalah ID koleksi. Ambil keduanya dari Workspace dan koleksi, atau salin dari Studio.

Endpoint

MethodPathFungsinya
POST/api/v1/auth/loginLogin dan ambil token
GET/api/v1/auth/meUser yang sedang login
POST/api/v1/auth/logoutCabut token yang kamu kirim
GET/api/v1/workspacesWorkspace yang bisa kamu akses
GET/api/v1/workspaces/:workspace/collectionsKoleksi beserta field-nya
GET/api/v1/workspaces/:workspace/collections/:collection/recordsDaftar dan query record
GET/api/v1/workspaces/:workspace/collections/:collection/records/:recordAmbil satu record
POST/api/v1/workspaces/:workspace/collections/:collection/recordsBuat record
PATCH/api/v1/workspaces/:workspace/collections/:collection/records/:recordUbah field sebuah record
DELETE/api/v1/workspaces/:workspace/collections/:collection/records/:recordHapus record
POST/api/v1/workspaces/:workspace/graphqlGraphQL untuk workspace
GET/health/liveCek liveness, tanpa login

Import, export, file, anggota, dan peran punya endpoint lain. Referensi API di Studio mencantumkan semuanya untuk workspace kamu.

Format respons

Respons yang berhasil menaruh hasilnya di data. Respons daftar menambahkan pagination ke meta:

{
	"data": [{ "title": "Cloud migration" }],
	"meta": {
		"request_id": "ZILI2GCARTZPNVR6JBAWQV2VMZ",
		"response_time": 1.78,
		"pagination": { "limit": 50, "offset": 0, "count": 7, "has_more": false }
	}
}

Error menaruh kode dan pesan di error:

{
	"error": { "code": "not_found", "message": "The requested resource is unavailable." },
	"meta": { "request_id": "L7DIIN4JO5XT4WPN2JQC7YCYBI", "response_time": 0.36 }
}
  • response_time dalam milidetik.
  • request_id sama dengan yang ada di log server dan header X-Request-ID. Sertakan saat kamu melaporkan masalah.
  • Delete mengembalikan 204 tanpa body.

Error

Yang paling sering adalah 400 invalid_input, 401 authentication_required, 403 access_denied, dan 404 not_found. Lihat Error untuk semua kode, pesannya, dan cara mengatasinya.

OpenAPI

Referensi API di Studio mengekspor dokumen OpenAPI 3.1 untuk workspace kamu. Isinya hanya yang boleh diakses akunmu, jadi kamu bisa membuat client bertipe dengan tool OpenAPI apa pun.

Langkah berikutnya

Traktir kopi