Get Tools Lab Pengembang API
Integrasikan alat, panduan, dan alur kerja platform yang diterbitkan menggunakan titik akhir pengembang yang diautentikasi. Kemampuan yang tersedia bergantung pada modul API yang diaktifkan dan tingkat akses Anda.
opsi API
Platform ini mencakup titik akhir REST dan lapisan ringan yang kompatibel dengan GraphQL, dengan dukungan untuk kunci API, kredensial klien OAuth, analisis penggunaan, batas kecepatan, dan pengiriman webhook yang ditandatangani. Tidak semua fitur situs publik tersedia secara otomatis melalui API.
Otentikasi
Titik akhir REST v1 dapat menggunakan kunci API di X-API-Key tajuk. Titik akhir yang lebih baru juga dapat menerima token pembawa yang didukung. Jaga kerahasiaan semua kredensial dan segera putar kunci jika terbuka.
curl -H "X-API-Key: qc_your_key" "https://gettoolslab.com/api/v1/tools.php"
Titik akhir REST umum
Alat
GET /api/v1/tools.php
GET /api/v1/tools.php?category=PDF
GET /api/v1/tools.php?q=json
Panduan
GET /api/v1/guides.php
GET /api/v1/guides.php?q=image
REST v2 dan GraphQL
Platform pengembang terkonsolidasi dapat mengekspos rute REST dan operasi GraphQL yang lebih baru untuk sumber daya yang didukung. Gunakan area Pengembang dan taman bermain API untuk melihat titik akhir yang sebenarnya diaktifkan pada penerapan saat ini.
Batas tarif
Permintaan API mungkin dibatasi per menit atau per hari. Permintaan yang melebihi batasnya dapat mengembalikan HTTP 429 Too Many Requests bersama dengan informasi coba lagi atau setel ulang. Aplikasi harus menggunakan backoff daripada langsung mengulangi permintaan yang gagal.
Webhook
Peristiwa yang didukung dapat dikirimkan ke tujuan webhook HTTPS. Jika penandatanganan diaktifkan, verifikasi tanda tangan HMAC sebelum memercayai payload. Konsumen webhook juga harus menoleransi percobaan ulang dan harus membuat pemrosesan peristiwa menjadi idempoten sehingga pengiriman yang sama tidak menimbulkan tindakan duplikat.
Kesalahan
Kredensial yang tidak valid, klien yang dinonaktifkan, kuota habis, atau permintaan yang salah format dapat mengembalikan kesalahan JSON terstruktur dengan kode status HTTP 4xx. Kegagalan sisi server menggunakan respons 5xx. Aplikasi harus mencatat status respons dan pengidentifikasi permintaan jika tersedia daripada mengekspos kredensial rahasia dalam laporan kesalahan.
Keamanan guidance
- Jangan pernah menyematkan kunci API rahasia di JavaScript browser publik.
- Gunakan HTTPS untuk lalu lintas API dan webhook.
- Berikan klien hanya izin yang mereka perlukan.
- Validasi tanda tangan webhook.
- Putar kredensial yang disusupi.
- Hormati batas kecepatan dan batas ukuran file yang terdokumentasi.
SDK dan taman bermain
Kunjungi bagian Pengembang untuk melihat contoh SDK dan taman bermain interaktif. Uji integrasi dengan data non-sensitif sebelum menggunakan file produksi atau informasi pelanggan.