Tim Kencang.in
API Kencang.in membenarkan aplikasi anda membuat, membaca, menukar dan memadam pautan pendek, kod QR dan halaman bio tanpa membuka papan pemuka. Artikel ini ialah titik permulaan: cara mendapatkan kunci, format permintaan dan contoh pertama yang boleh dijalankan dalam masa lima minit. Dokumentasi lengkap untuk setiap titik akhir tersedia di halaman pembangun.
1. Dapatkan kunci API
Log masuk ke papan pemuka, buka menu Pembangun (atau Tetapan > API). Setiap akaun mempunyai satu kunci induk, dan anda boleh membuat kunci tambahan dengan nama berbeza untuk setiap aplikasi supaya kunci yang bocor boleh dibatalkan tanpa mengganggu integrasi lain. Akses API tersedia dalam pelan Pro dan Business; lihat had di halaman harga.
2. Pengesahan
Semua permintaan mesti termasuk pengepala Authorization: Bearer KUNCI_API_ANDA. Skema Bearer mengikuti RFC 6750. Permintaan tanpa kunci atau dengan kunci yang dibatalkan menerima respons HTTP 401. Sentiasa hantar permintaan melalui HTTPS; kunci yang dihantar melalui HTTP biasanya dianggap bocor.
3. Format permintaan dan respons
API menerima dan mengembalikan JSON. Sertakan pengepala Content-Type: application/json pada permintaan POST dan PUT. Setiap respons mempunyai kunci error: nilai 0 bermakna kejayaan, jika tidak ia akan disertai message yang menjelaskan masalah. Semak kunci ini sebelum membaca data lain. Format JSON mengikut spesifikasi dalam json.org.
4. Permintaan pertama: buat pautan pendek
Parameter yang biasa digunakan pada titik akhir pembuatan pautan:
url(diperlukan): URL Destinasi, mesti bermula dengan http:// atau https://.custom: alias tersuai. Jika kosong, alias rawak dibuat.domain: domain berjenama yang disahkan dalam akaun anda.password: perlindungan kata laluan.expiry: tarikh tamat tempoh dalam format YYYY-MM-DD.type: jenis ubah hala, cthdirectatausplashuntuk halaman pendaratan tersuai.metatitle,metadescription: tajuk pratonton dan penerangan.geotarget,devicetarget,languagetarget: peraturan penyasaran dalam bentuk tatasusunan.
Respons mengandungi id pautan dan shorturl yang sedia dikongsi. Simpan id jika aplikasi anda perlu menukar atau memadam pautan itu kemudian.
5. Baca dan uruskan pautan
GET /api/urls: senarai pautan dengan penomboran halaman (parameterpage,limit,order).GET /api/url/{id}: perincian satu pautan berserta statistik ringkas.PUT /api/url/{id}/update: tukar destinasi, alias atau tetapan lain.DELETE /api/url/{id}/delete: padam pautan.
Titik akhir yang serupa tersedia untuk kod QR, halaman bio, kempen, domain dan piksel. Kami menulis contoh kod dalam beberapa bahasa pengaturcaraan secara berasingan dalam artikel buat pautan pendek melalui API dengan PHP, Python dan JavaScript.
6. Had kadar
Setiap pelan mempunyai had permintaan seminit. Pengepala respons X-RateLimit-Limit dan X-RateLimit-Remaining memberitahu baki kuota, dan permintaan yang melebihi had mendapat HTTP 429. Strategi untuk menanganinya dibincangkan dalam artikel had kadar dan pengendalian ralat.
7. Amalan keselamatan kunci API
- Simpan kunci dalam pembolehubah persekitaran atau pengurus rahsia, bukan dalam repositori kod.
- Jangan sekali-kali menggunakan kunci dalam JavaScript sebelah pelayar atau aplikasi mudah alih yang diedarkan; sediakan backend perantara.
- Buat kunci berasingan bagi setiap aplikasi dan batalkan kunci yang tidak digunakan.
- Cadangan am untuk menguruskan rahsia boleh dibaca di Lembaran Cheat Pengurusan Rahsia OWASP.
Langkah seterusnya
Selepas permintaan pertama berjaya, anda boleh mengautomasikan penciptaan pautan daripada hamparan melalui Zapier dan Google Sheets, atau terima pemberitahuan klik masa nyata melalui webhooks dan Slack.
Soalan lazim
Adakah API tersedia pada pelan Percuma?
Akses API tersedia dalam pelan Pro dan Business. Pelan Pro mendapat 60 permintaan seminit dan pelan Business 300 seminit. Tempoh percubaan 7 hari pada pelan berbayar merangkumi akses API penuh untuk menguji integrasi.
Bagaimana jika kunci API saya bocor?
Batalkan kunci segera melalui menu Pembangun dan buat kunci baharu. Oleh sebab setiap kunci berasingan, integrasi lain yang menggunakan kunci berbeza tidak terganggu. Semak juga log permintaan untuk melihat sebarang aktiviti mencurigakan.
Adakah API menyokong pembuatan kod QR dan halaman bio?
Ya. Selain pautan, terdapat titik akhir untuk kod QR, halaman bio, kempen, domain, piksel dan statistik. Semua titik akhir menggunakan pengesahan Bearer yang sama dan mengembalikan JSON dengan struktur error dan message yang konsisten.
Bolehkah API dipanggil daripada apl mudah alih atau JavaScript penyemak imbas?
Sebaiknya jangan, kerana kunci API akan kelihatan kepada pengguna. Sediakan titik akhir pada backend anda sendiri yang menyimpan kunci dengan selamat dan memajukan permintaan ke API Kencang.in.
