เริ่มต้นใช้ API ของ Kencang.in

Kencang.in API ช่วยให้แอปพลิเคชันของคุณสร้าง อ่าน เปลี่ยนแปลง และลบลิงก์สั้น คิวอาร์โค้ด และหน้าไบโอโดยไม่ต้องเปิดแดชบอร์ด บทความนี้เป็นจุดเริ่มต้น: วิธีรับคีย์ รูปแบบคำขอ และตัวอย่างแรกที่สามารถดำเนินการได้ภายในห้านาที เอกสารฉบับสมบูรณ์สำหรับแต่ละปลายทางมีอยู่ที่ หน้านักพัฒนาซอฟต์แวร์.

1. รับคีย์ API

เข้าสู่แดชบอร์ด เปิดเมนู นักพัฒนา (หรือการตั้งค่า > เอพีไอ) แต่ละบัญชีมีคีย์หลักหนึ่งคีย์ และคุณสามารถสร้างคีย์เพิ่มเติมด้วยชื่อที่แตกต่างกันสำหรับแต่ละแอปพลิเคชัน ดังนั้นคีย์ที่รั่วไหลจึงสามารถเพิกถอนได้โดยไม่รบกวนการผสานรวมอื่นๆ การเข้าถึง API มีให้ในแพ็กเกจ Pro และ Business ดูขีดจำกัดบนหน้า ราคา.

ขั้นตอนการตรวจสอบความถูกต้อง - เริ่มต้นใช้ API ของ Kencang.in: คีย์ API การยืนยันตัวตน และคำขอแรก — ขั้นตอนการตรวจสอบความถูกต้อง

2. การรับรองความถูกต้อง

คำขอทั้งหมดต้องมีส่วนหัว Authorization: Bearer YOUR_API_KEY. แผนการของผู้ถือดังต่อไปนี้ อาร์เอฟซี 6750. คำขอที่ไม่มีคีย์หรือคีย์ที่ถูกเพิกถอนจะได้รับการตอบกลับ HTTP 401 ส่งคำขอผ่าน HTTPS เสมอ คีย์ที่ส่งผ่าน HTTP มักจะถือว่ารั่วไหล

3. รูปแบบคำขอและการตอบกลับ

API ยอมรับและส่งกลับ JSON รวมส่วนหัว Content-Type: application/json ในคำขอ POST และ PUT แต่ละคำตอบมีกุญแจ error: ค่า 0 หมายถึงความสำเร็จ ไม่เช่นนั้นก็จะตามมาด้วย message ซึ่งอธิบายปัญหา ตรวจสอบคีย์นี้ก่อนที่จะอ่านข้อมูลอื่น รูปแบบ JSON เป็นไปตามข้อกำหนดใน json.org.

4. คำขอแรก: สร้างลิงก์สั้น ๆ

คำขอแรกด้วย cURL - เริ่มต้นใช้ API ของ Kencang.in: คีย์ API การยืนยันตัวตน และคำขอแรก — คำขอแรกด้วย cURL

พารามิเตอร์ทั่วไปที่ใช้ในเอนด์พอยต์การสร้างลิงก์:

url (จำเป็น): URL ปลายทางต้องขึ้นต้นด้วย http:// หรือ https://
custom: ชื่อย่อที่กำหนดเอง หากว่างเปล่า ระบบจะสร้างชื่อย่อแบบสุ่มขึ้นมา
domain: โดเมนที่มีแบรนด์ที่ยืนยันแล้วในบัญชีของคุณ
password: การป้องกันด้วยรหัสผ่าน
expiry: วันหมดอายุในรูปแบบ ปปปป-ดด-วว
type: ประเภทการเปลี่ยนเส้นทาง เช่น direct หรือ splash สำหรับหน้าแลนดิ้งเพจ ที่กำหนดเอง
metatitle, metadescription: ดูตัวอย่างชื่อและคำอธิบาย
geotarget, devicetarget, languagetarget: กฎการกำหนดเป้าหมายในรูปแบบอาร์เรย์

การตอบสนองประกอบด้วย ลิงก์ id และ shorturl ซึ่งพร้อมที่จะแชร์ บันทึก id หากแอปพลิเคชันของคุณจำเป็นต้องเปลี่ยนแปลงหรือลบลิงก์ในภายหลัง

5. อ่านและจัดการลิงก์

GET /api/urls: รายการลิงก์ที่มีการแบ่งหน้า (parameters page, limit, order).
GET /api/url/{id}: รายละเอียดของหนึ่งลิงก์พร้อมสถิติโดยย่อ
PUT /api/url/{id}/update: เปลี่ยนปลายทาง ชื่อย่อ หรือการตั้งค่าอื่นๆ
DELETE /api/url/{id}/delete: ลบลิงก์

เอนด์พอยต์ที่คล้ายกันมีให้ใช้งานสำหรับคิวอาร์โค้ด, หน้าไบโอ, แคมเปญ, โดเมน และพิกเซล เราเขียนตัวอย่างโค้ดในภาษาการเขียนโปรแกรมหลายภาษาแยกกันในบทความ สร้างลิงก์สั้นผ่าน API ด้วย PHP, Python และ JavaScript.

6. ขีดจำกัดอัตรา

แต่ละแพ็กเก็ตมีการจำกัดคำขอต่อนาที ส่วนหัวของการตอบกลับ X-RateLimit-Limit และ X-RateLimit-Remaining บอกโควต้าที่เหลือ และคำขอที่เกินขีดจำกัดจะได้รับ HTTP 429 กลยุทธ์ในการจัดการกับสิ่งนี้จะมีการกล่าวถึงในบทความ ขีดจำกัดอัตราและการจัดการข้อผิดพลาด.

7. แนวปฏิบัติด้านความปลอดภัยของคีย์ API

เก็บคีย์ไว้ในตัวแปรสภาพแวดล้อมหรือตัวจัดการความลับ ไม่ใช่ในที่เก็บโค้ด
ห้ามใช้คีย์ใน JavaScript ฝั่งเบราว์เซอร์หรือแอปพลิเคชันมือถือแบบกระจาย สร้างแบ็กเอนด์ระดับกลาง
สร้างคีย์แยกกันสำหรับแต่ละแอปพลิเคชัน และเพิกถอนคีย์ที่ไม่ได้ใช้
สามารถอ่านคำแนะนำทั่วไปสำหรับการจัดการความลับได้ที่ เอกสารสรุปการจัดการความลับของ OWASP.

ขั้นตอนต่อไป

หลังจากคำขอครั้งแรกสำเร็จ คุณสามารถสร้างลิงก์จากสเปรดชีตโดยอัตโนมัติผ่านทาง Zapier และ Google Sheetsหรือรับการแจ้งเตือนการคลิกแบบเรียลไทม์ผ่านทาง webhooks และ Slack.

คำถามที่พบบ่อย

API มีอยู่ในแพ็กเกจฟรีหรือไม่

การเข้าถึง API มีอยู่ในแพ็กเกจ Pro และ Business แพ็กเกจ Pro ได้รับ 60 คำขอต่อนาที และแพ็กเกจธุรกิจ 300 คำขอต่อนาที ระยะเวลาทดลองใช้งาน 7 วันสำหรับแพ็กเกจแบบชำระเงินรวมถึงการเข้าถึง API เต็มรูปแบบเพื่อทดสอบการผสานรวม

จะเกิดอะไรขึ้นหากคีย์ API ของฉันรั่วไหล

ลบคีย์ออกจากเมนูนักพัฒนาซอฟต์แวร์ทันทีและสร้างคีย์ใหม่ เนื่องจากแต่ละคีย์มีความเป็นอิสระ การผสานรวมอื่นๆ ที่ใช้คีย์ที่แตกต่างกันจึงไม่ถูกรบกวน ตรวจสอบบันทึกคำขอเพื่อดูว่ามีกิจกรรมที่น่าสงสัยหรือไม่

API รองรับการสร้างคิวอาร์โค้ด และหน้าไบโอหรือไม่

ใช่ นอกจากลิงก์แล้ว ยังมีเอนด์พอยต์สำหรับคิวอาร์โค้ด, ไบโอเพจ, แคมเปญ, โดเมน, พิกเซล และสถิติอีกด้วย เอนด์พอยต์ทั้งหมดใช้การตรวจสอบสิทธิ์ Bearer เดียวกันและส่งคืน JSON โดยมีข้อผิดพลาดและโครงสร้างข้อความที่สอดคล้องกัน

สามารถเรียก API จากแอปพลิเคชันมือถือหรือเบราว์เซอร์ JavaScript ได้หรือไม่

เราไม่แนะนำ เนื่องจากคีย์ API จะมองเห็นได้โดยผู้ใช้ สร้างเอนด์พอยต์ในแบ็กเอนด์ของคุณเองที่จะจัดเก็บคีย์อย่างปลอดภัยและส่งต่อคำขอไปยัง Kencang.in API

Tim Kencang.in

Ditulis oleh tim produk dan marketing Kencang.in, pemendek link, QR code dinamis, dan bio page buatan Indonesia yang dioperasikan oleh PT Kode Digital Solusindo. Kami menulis berdasarkan pengalaman mengelola kampanye klien dan membangun fitur yang dibahas.

Tentang Kencang.in ติดต่อเรา

เริ่มต้นใช้ API ของ Kencang.in: คีย์ API การยืนยันตัวตน และคำขอแรก