REST API

Setiap tindakan di antarmuka Celerp adalah endpoint REST - API yang sama yang digunakan UI secara internal. Otomatiskan alur kerja, hubungkan sistem lain, atau bangun alat Anda sendiri. API berjalan secara lokal dengan data Anda; tidak ada yang dikirim ke cloud.

🔗 URL Dasar

http://localhost:8000 pada instalasi pip. Aplikasi desktop memilih port sendiri: lihat celerp-data/api-port.

🔑 Autentikasi

Bearer JWT dari /auth/login

📦 Format

JSON masuk, JSON keluar

📖 Spesifikasi

GET /openapi.json (OpenAPI 3.1)

Port mana? Dengan pip install celerp, server API berjalan di localhost:8000 (ubah dengan --api-port) dan port 8080 adalah UI web untuk pengguna, bukan API. Aplikasi desktop memilih port yang kosong setiap kali dijalankan dan menulis port API ke file api-port di folder celerp-data. Untuk menetapkan port, atur CELERP_API_PORT sebelum menjalankannya.

Autentikasi

Celerp menggunakan JSON Web Token berumur pendek. Masuk dengan email dan kata sandi Celerp Anda untuk mendapatkan access token, lalu kirimkan sebagai header Bearer pada setiap permintaan.

1. Masuk

curl -X POST http://localhost:8000/auth/login \
  -H "Content-Type: application/json" \
  -d '{"email": "[email protected]", "password": "your-password"}'

Respons berisi dua token:

{
  "access_token": "eyJhbGciOiJI...",
  "refresh_token": "eyJhbGciOiJI..."
}

2. Panggil API dengan token

curl http://localhost:8000/items \
  -H "Authorization: Bearer eyJhbGciOiJI..."
  • Token mengidentifikasi pengguna, peran, dan perusahaan Anda, sehingga permintaan secara otomatis dibatasi ke perusahaan tersebut - tidak perlu header tambahan.
  • Access token berlaku hingga 24 jam. Saat kedaluwarsa, dapatkan pasangan baru dengan melakukan POST refresh_token ke /auth/token/refresh.
  • Tergabung di lebih dari satu perusahaan? Tampilkan daftarnya dengan GET /auth/my-companies, lalu ambil token untuk perusahaan lain dengan POST /auth/switch-company/{company_id}.

Token membawa izin Anda. Token viewer hanya bisa membaca, tidak menulis; data biaya membutuhkan peran manager atau lebih tinggi. Perlakukan token seperti kata sandi - siapa pun yang memegangnya dapat bertindak sebagai Anda.

Membuat permintaan

Semua endpoint berada di bawah alamat server API Anda (http://localhost:8000 pada instalasi pip, seperti pada contoh di bawah) dan mengembalikan JSON. Endpoint daftar mengembalikan array items dan jumlah total:

curl "http://localhost:8000/items?limit=20&offset=0" \
  -H "Authorization: Bearer $TOKEN"
{
  "items": [
    { "id": "item:...", "sku": "WIDGET-001", "name": "Widget", "quantity": 42 }
  ],
  "total": 142
}

Paginasi: kirim ?limit= (default 50) dan ?offset=. Sebagian besar endpoint daftar juga menerima kata kunci pencarian q= dan filter kolom (mis. ?status=available).

Membuat data

Kirim POST berisi JSON untuk membuat data. Operasi tulis mengembalikan id entitas baru (dan event_id yang mendasarinya - setiap perubahan di Celerp adalah sebuah event).

curl -X POST http://localhost:8000/crm/contacts \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Acme Corp",
    "email": "[email protected]",
    "contact_type": "customer",
    "idempotency_key": "acme-2026-06-21"
  }'

Idempotensi: sertakan idempotency_key pada setiap penulisan. Permintaan yang dicoba ulang dengan kunci yang sama tidak akan membuat duplikat - aman untuk jaringan tidak stabil dan pekerjaan batch.

Konvensi

  • Kesalahan respons non-2xx mengembalikan {"detail": "..."} dengan kode status HTTP standar.
  • Batas laju permintaan 60 permintaan/menit per IP secara default; login dibatasi 10/menit. Melebihi batas mengembalikan 429.
  • Izin endpoint dikontrol oleh peran Anda: viewer → operator → manager → admin → owner.
  • Cakupan perusahaan setiap permintaan bertindak pada perusahaan dalam token Anda; ganti perusahaan untuk bertindak pada yang lain.

Endpoint umum

Sebagian kecil untuk memulai. Setiap modul menambahkan miliknya sendiri - daftar lengkap ada di skema OpenAPI di bawah.

MetodePathDeskripsi
POST/auth/loginDapatkan access token (tidak perlu autentikasi)
GET/healthStatus layanan (tidak perlu autentikasi)
GET/itemsDaftar item persediaan
POST/itemsBuat item
GET/docsDaftar dokumen (faktur, PO, tagihan, …)
POST/docsBuat dokumen
GET/crm/contactsDaftar pelanggan & pemasok
POST/crm/contactsBuat kontak
GET/dashboard/kpisKPI bisnis

Referensi lengkap per area

Setiap endpoint yang disediakan API yang sedang berjalan, dikelompokkan per area. Setiap halaman mencantumkan method, path, parameter, bentuk request dan response, serta contoh pemanggilan.

Auth

API autentikasi untuk pengguna Celerp, login, logout, pemulihan kata sandi, perpindahan perusahaan, dan akses API. (16 endpoints)

Bahasa Inggris

Companies

API pengaturan dan administrasi perusahaan untuk pengguna, peran, lokasi, pajak, syarat pembayaran, daftar harga, modul, dan preferensi perusahaan. (75 endpoints)

Bahasa Inggris

Items

API inventaris untuk produk dan barang stok, jumlah, harga, lokasi, kode batang, penilaian, impor, reservasi, pemindahan, transformasi, dan status stok. (38 endpoints)

Bahasa Inggris

Docs

API dokumen bisnis untuk faktur penjualan, tagihan pembelian, pesanan pembelian, penawaran harga, nota kredit, dokumen pengiriman, pembayaran, pemenuhan pesanan, keluaran PDF, dan operasi siklus hidup dokumen. (56 endpoints)

Bahasa Inggris

Lists

API daftar inventaris untuk audit stok, pemindahan, penghapusan nilai, manifes, pemindaian, reservasi, catatan, ekspor, dan operasi siklus hidup daftar. (41 endpoints)

Bahasa Inggris

Accounting

REST API akuntansi Celerp untuk bagan akun, jurnal, buku besar, rekonsiliasi bank, laporan keuangan, transfer, dan pengendalian periode fiskal. (73 endpoints)

Bahasa Inggris

Ledger

API buku besar peristiwa untuk membaca peristiwa bisnis Celerp dan membangun ulang data aplikasi turunan. (3 endpoints)

Bahasa Inggris

Reports

API pelaporan ERP untuk analisis umur piutang dan utang, penjualan, pembelian, dan persediaan yang mendekati kedaluwarsa. (5 endpoints)

Bahasa Inggris

Manufacturing

API manufaktur untuk perintah produksi, resep, pusat kerja, alur kerja, kebutuhan bahan, perhitungan biaya, penjadwalan, pengeluaran komponen, dan penerimaan barang jadi. (32 endpoints)

Bahasa Inggris

Labels

API label inventaris dan kode batang untuk templat label, label per barang, lembar label massal, dan PDF siap cetak. (10 endpoints)

Bahasa Inggris

Crm

REST API CRM untuk pelanggan, pemasok, kontak, alamat, orang, catatan, tag, berkas, impor, ekspor, dan pengelolaan kontak. (25 endpoints)

Bahasa Inggris

Subscriptions

API dokumen berulang dan langganan untuk templat faktur serta pesanan pembelian, penjadwalan, aktivasi, jeda, pelanjutan, pembatalan, dan pembuatan sesuai permintaan. (22 endpoints)

Bahasa Inggris

Connectors

API integrasi untuk menghubungkan Celerp ERP dengan platform perdagangan dan bisnis eksternal, mengelola kredensial konektor, dan menyinkronkan data. (18 endpoints)

Bahasa Inggris

Payments

API integrasi pembayaran untuk menghubungkan pemrosesan pembayaran, memeriksa ketersediaan pembayaran, dan membaca status koneksi. (7 endpoints)

Bahasa Inggris

Backup

API pencadangan dan pemulihan untuk mengekspor, mengimpor, menampilkan daftar, membuat, dan memulihkan cadangan Celerp ERP. (8 endpoints)

Bahasa Inggris

Notifications

API notifikasi pengguna untuk menampilkan daftar notifikasi dan menandai satu atau semua notifikasi sebagai telah dibaca. (3 endpoints)

Bahasa Inggris

Events

API peristiwa real-time yang dikirim server (SSE) untuk notifikasi Celerp dan peristiwa langsung dalam aplikasi. (1 endpoint)

Bahasa Inggris

System

Endpoint kesehatan sistem, kesiapan, mulai ulang, dan reset pabrik untuk instalasi Celerp ERP. (10 endpoints)

Bahasa Inggris

Admin

Endpoint diagnostik administratif dan status sistem untuk memelihara instalasi Celerp ERP. (2 endpoints)

Bahasa Inggris

Ai

API AI Celerp untuk percakapan dengan asisten ERP, ekstraksi dokumen, pekerjaan batch, memori, penggunaan, dan tindakan bisnis yang dikonfirmasi pengguna. (26 endpoints)

Bahasa Inggris

Attachments

API lampiran inventaris untuk mengunggah, mengunduh, memberi tag, melihat pratinjau, dan menghapus berkas barang serta gambar produk. (12 endpoints)

Bahasa Inggris

Dashboard

API dasbor untuk indikator kinerja utama ERP, aktivitas bisnis terbaru, dan riwayat aktivitas yang dapat dicari. (3 endpoints)

Bahasa Inggris

Payments Public

Endpoint pembayaran publik untuk tautan pembayaran pelanggan dan penanganan pengembalian dari penyedia pembayaran. (2 endpoints)

Bahasa Inggris

Received

API dokumen yang diterima dari pengguna Celerp lain: tampilkan dan tinjau dokumen, catat salah satunya sebagai draf milik Anda, lalu perbarui draf tersebut sesuai revisi terbaru pengirim. (5 endpoints)

Bahasa Inggris

Search

API pencarian global Celerp ERP untuk menemukan catatan yang boleh diakses di berbagai modul melalui satu kueri. (1 endpoint)

Bahasa Inggris

Settings

API pengaturan sistem dan Celerp Connect untuk penyiapan akun, status koneksi cloud, penagihan, cadangan, konektor, dan konfigurasi mitra. (18 endpoints)

Bahasa Inggris

Share

API berbagi dokumen untuk membuat, memeriksa, memperbarui, dan mencabut tautan berbagi publik bagi dokumen dan daftar Celerp. (4 endpoints)

Bahasa Inggris

Share Public

Endpoint publik untuk berbagi dan mengimpor dokumen, melihat dokumen Celerp yang dibagikan, serta mengunduh atau mengimpor paket dokumen portabel. (4 endpoints)

Bahasa Inggris

Stars

API lencana pendukung dan apresiasi komunitas Celerp untuk verifikasi, tampilan, berhenti berpartisipasi, dan pesan ajakan. (6 endpoints)

Bahasa Inggris

Verticals

API pengaturan bawaan industri dan skema kategori untuk mengonfigurasi kolom serta nilai default Celerp ERP menurut sektor usaha. (5 endpoints)

Bahasa Inggris

Company Backups

27 endpoints

Bahasa Inggris

Company Peers

5 endpoints

Bahasa Inggris

Fixed Assets

117 endpoints

Bahasa Inggris

Help

3 endpoints

Bahasa Inggris

Migrations

39 endpoints

Bahasa Inggris

Jelajahi API lengkap

Referensi lengkap dan selalu terkini adalah skema OpenAPI 3.1 yang dihasilkan oleh instance Anda sendiri:

GET http://localhost:8000/openapi.json

Muat ke alat OpenAPI apa pun - Postman, Insomnia, Swagger UI, atau generator client - untuk menelusuri setiap endpoint dan model, mencoba permintaan, dan menghasilkan client bertipe dalam bahasa Anda. Celerp memberikan skemanya sendiri, bukan halaman dokumentasi yang dihosting, sehingga cakupan API Anda tetap privat di instance Anda.

Lebih suka bahasa alami? Asisten AI (Connect) memanggil API yang sama ini untuk Anda - minta untuk menarik laporan atau membuat dokumen dalam bahasa alami. Dan ingat: apa pun yang bisa dilakukan API, dilakukan tanpa akses khusus - persis seperti yang bisa dilakukan pengguna yang masuk.