API Pengembang
Panggil alat dari perangkat lunak Anda sendiri tanpa browser: kirim permintaan, mulai pekerjaan, dan unduh output. Semua endpoint berada di satu alamat berversi; setiap permintaan diotorisasi dengan kunci pribadi.
Alur pekerjaan
Satu panggilan memulai pekerjaan konversi dan memberi Anda ID pekerjaan. Dengan ID itu Anda memeriksa status pekerjaan dan mengunduh output setelah selesai. Pekerjaan bisa memakan waktu, jadi pemisahan ini memungkinkan klien menunggu tanpa memblokir alurnya.
Kunci dan akses
Permintaan ditandatangani dengan header Authorization: Bearer. Buat kunci Anda di akun Anda dan cabut kapan pun; kunci teks polos hanya ditampilkan saat dibuat. Sesi browser tidak dihitung sebagai auth di sini.
Alat dengan permukaan API terbuka
| Alat | Permukaan API | Dokumen |
|---|---|---|
| GambarMini | Konverter — POST /run | Dokumen |
| Buku Pemasukan-Pengeluaran | 10 endpoint (aplikasi berstatus) | Dokumen |
| PdfSplit | Konverter — POST /run | Dokumen |
Pembuatan versi dan kontrak
Endpoint diversi di bawah https://api.pixepi.com dengan /api/v1; perubahan yang tidak kompatibel ke belakang memerlukan versi baru. Kontrak yang dapat dibaca mesin dipublikasikan sebagai OpenAPI 3.1 dan dapat langsung dimasukkan ke generator klien.
Respons dan error
Respons berada dalam amplop JSON; setiap pekerjaan diperiksa dengan ID-nya sendiri dan kepemilikan catatan diverifikasi di server. Saat terjadi kesalahan, respons mengembalikan kode yang menjelaskan keadaannya; klien menerjemahkan kode itu ke bahasanya sendiri.
Mendalami lebih jauh
- Tautan API di halaman alat yang Anda pilih; membuka endpoint, kolom permintaan, opsi, dan perilaku error alat itu.
- Kontrak yang dapat dibaca mesin: dokumen OpenAPI.
- Halaman pengembang pusat: daftar bersama semua endpoint.