Buku kas API

Buku kas API, Buku Pemasukan-Pengeluaran mengelola catatannya dari aplikasi Anda sendiri: daftar, tambah, perbarui, dan hapus. Endpoint bekerja dengan kunci API, bukan sesi browser.

Mulai cepat

Buat kunci di bagian API Pengembang di akun Anda; kunci teks polos hanya ditampilkan saat dibuat.
Kirim permintaan ke https://api.pixepi.com dengan header Authorization: Bearer <key>.
Respons mengembalikan JSON; di endpoint daftar Anda dapat memakai kolom page, per_page, dan filter.

Contoh permintaan

curl -H "Authorization: Bearer $PIXEPI_KEY" "https://api.pixepi.com/api/v1/apps/gelir-gider-defteri/categories"

curl -X POST "https://api.pixepi.com/api/v1/apps/gelir-gider-defteri/categories" \
  -H "Authorization: Bearer $PIXEPI_KEY" \
  -d "kind=expense" \
  -d "name=Sewa"

Endpoint alat ini

Metode	Path	Fungsinya
`GET`	`/categories`	Menampilkan daftar kategori (kategori sistem bersama dan kategori milik Anda).
`POST`	`/categories`	Menambahkan kategori baru.
`POST`	`/categories/{id}`	Memperbarui kategori.
`POST`	`/categories/{id}/archive`	Mengarsipkan kategori; pemanggilan ulang tidak mengubah status.
`GET`	`/entries`	Menampilkan daftar transaksi; memfilter berdasarkan tanggal, jenis, kategori, dan catatan.
`POST`	`/entries`	Menambahkan transaksi baru.
`POST`	`/entries/{id}`	Memperbarui transaksi.
`POST`	`/entries/{id}/delete`	Menghapus transaksi.
`GET`	`/summary`	Rincian ringkasan: menurut bulan, kategori, atau jenis.
`GET`	`/export.csv`	Mengekspor transaksi sebagai CSV.

Endpoint bersama

Metode	Path	Fungsinya
`GET`	`/api/v1/apps`	Katalog API
`GET`	`/api/v1/apps/gelir-gider-defteri`	Kontrak alat
`GET`	`/api/v1/usage`	Ringkasan penggunaan
`GET`	`/api/v1/openapi.json`	Dokumen OpenAPI 3.1

Batas

Kolom limit di respons daftar membawa informasi penggunaan dan batas.
Informasi kuota dan paket terikat ke akun Anda; periksa status terkini dengan GET /api/v1/usage.

Kode error

Kode	Arti
`unauthorized`	Kunci API tidak ada atau tidak valid.
`forbidden`	Operasi ini tidak diizinkan dengan kunci ini.
`not_found`	Alat, pekerjaan, atau catatan tidak ditemukan (404 juga untuk akses lintas akun).
`invalid_input`	Input gagal validasi (kolom kurang atau cacat, tanggal tidak valid, dan sebagainya).
`invalid_request`	Permintaan cacat.
`too_large`	Ukuran file atau body melebihi batas.
`unsupported_media`	Jenis file tidak diterima.
`not_supported`	Alat ini tidak dapat berjalan di endpoint ini (aplikasi berstatus).
`not_ready`	Pekerjaan belum selesai.
`expired`	Output sudah kedaluwarsa.
`no_output`	Tidak ada output yang dapat diunduh untuk pekerjaan ini.
`invalid_path`	Path output tidak valid.
`quota_exceeded`	Kuota atau batas laju terlampaui.
`rate_limited`	Terlalu banyak permintaan dalam waktu singkat; tunggu sebentar dan coba lagi.
`csrf`	Verifikasi formulir browser gagal (API eksternal memakai kunci).
`conflict`	Operasi bertentangan dengan status saat ini.
`unavailable`	Alat ditutup sementara.
`internal_error`	Error server tak terduga.

Dokumen

Pertanyaan yang sering diajukan

Di mana saya mendapatkan kunci API?

Buat kunci di bagian API Pengembang di akun Anda; kunci ditampilkan sekali, saat dibuat.

Bagaimana permintaan dikirim?

Endpoint berjalan di https://api.pixepi.com; setiap permintaan menyertakan header "Authorization: Bearer <key>".

Endpoint apa yang diekspos API Buku Pemasukan-Pengeluaran?

Tabel di atas mencantumkan endpoint yang dideklarasikan; semuanya bekerja dengan catatan yang terikat ke akun Anda dan mengembalikan 404 untuk akses lintas akun.

Bagaimana cara membaca respons error?

Body error membawa kolom {ok:false, error, code, request_id}; nilai code ada di tabel kode error.