Skip to main content
AltoPocket
นักพัฒนา

AltoPocket Integrations API

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

วิธีการทำงาน

เฉพาะพาร์ทเนอร์ที่ได้รับอนุมัติ

สมัครด้วยข้อมูลบริษัท ผู้ติดต่อ และ IP ของเซิร์ฟเวอร์ เจ้าหน้าที่ AltoPocket ตรวจสอบทุกใบสมัคร

ความสามารถแสดงหลังอนุมัติ

เมื่อได้รับอนุมัติ คอนโซลนักพัฒนาจะแสดงสิทธิ์ที่คีย์ของคุณขอได้ และคุณขอสิทธิ์ที่ต้องการพร้อมเหตุผล

ลงนาม เซิร์ฟเวอร์ถึงเซิร์ฟเวอร์

ทุกการเรียกมีคีย์และลายเซ็น HMAC และรับเฉพาะจาก IP ของเซิร์ฟเวอร์ในรายการที่อนุญาต

การดำเนินการที่ย้ายมูลค่าจะไม่ทำงานเอง: เจ้าหน้าที่ AltoPocket เป็นผู้อนุมัติ

การลงนามคำขอ

ทุกคำขอต้องมี API key (x-api-key) เวลา Unix (X-AP-Timestamp ภายใน ±5 นาที) และ X-AP-Signature ซึ่งคือ HMAC-SHA256 ด้วย signing secret ของคุณ คำนวณจากเวลา เมธอด HTTP พาธรวม query string และ SHA-256 ของไบต์ body ที่ส่งจริง โดยคั่นด้วยการขึ้นบรรทัดใหม่ ทุก POST ต้องมี Idempotency-Key ด้วย และรับคำขอเฉพาะจาก IP เซิร์ฟเวอร์ที่อยู่ในรายการอนุญาตเท่านั้น

เอกสาร Swagger สามารถลงนามคำขอ "Try it out" ในเบราว์เซอร์ได้ ใช้เฉพาะคีย์ sandbox เท่านั้น — ห้ามวาง signing secret ของระบบจริงลงในเบราว์เซอร์

เอกสารสาธารณะมีเพียงวิธีลงนาม การตรวจสอบการเชื่อมต่อ และการสมัคร พาร์ทเนอร์ที่ได้รับอนุมัติจะเห็นเอกสารฉบับเต็มตามสิทธิ์ของตน: ในหน้า Swagger ให้ใส่คีย์แซนด์บ็อกซ์แล้วเลือก “Unlock full docs” หรือเรียก GET /integrations/v1/docs/openapi.json (ต้องลงนาม) จากเซิร์ฟเวอร์ของคุณ

การทดสอบจาก Swagger

Try it out ลงนามแต่ละคำขอในเบราว์เซอร์ คำขอจึงมาจาก IP สาธารณะของเบราว์เซอร์ และ IP นั้นต้องได้รับอนุญาตสำหรับคีย์ของคุณ: IP เซิร์ฟเวอร์จริงของคุณ, IP ผู้ทดสอบในแซนด์บ็อกซ์ หรือการตั้งค่า “อนุญาตทุก IP” ในแซนด์บ็อกซ์ที่ผู้ดูแลของ AltoPocket เปิดให้ไคลเอนต์ของคุณได้ ปุ่ม “Check my IP” ในแผงลงนามจะแสดง IP ที่ API เห็น และการเรียกที่ถูกปฏิเสธจะบอก IP ที่ถูกปฏิเสธ ห้ามวางซีเคร็ตสำหรับลงนามของระบบจริงในเบราว์เซอร์เด็ดขาด

canonical = timestamp + "\n"
          + METHOD + "\n"
          + path_with_query + "\n"
          + hex(sha256(raw_body))

X-AP-Signature = hex(hmac_sha256(secret, canonical))
x-api-key      = apk_…
X-AP-Timestamp = unix seconds (±300 s)
Idempotency-Key = <every POST>

สภาพแวดล้อม

Sandbox

เครือข่ายทดสอบ (TRON Nile) และข้อมูลทดสอบ คีย์ที่ออกที่นี่ขึ้นต้นด้วย apk_dev_ หรือ apk_stage_

  • https://api.devkcw.com/api/v1/integrations/v1

ระบบจริง

สภาพแวดล้อมจริง คีย์ขึ้นต้นด้วย apk_live_ และออกแยกจากคีย์ sandbox

https://api.altopocket.com/api/v1/integrations/v1

ขอสิทธิ์หลังได้รับอนุมัติ

ใบสมัครไม่ขอสิทธิ์ใด ๆ เมื่อคีย์ได้รับอนุมัติและรับแล้ว คอนโซลนักพัฒนา (หรือ GET /integrations/v1/scopes ที่ลงนามด้วยคีย์ของคุณ) จะแสดงว่าแต่ละสิทธิ์ทำอะไรได้ แล้วคุณขอสิทธิ์ที่ต้องการพร้อมเหตุผล เจ้าหน้าที่ตรวจสอบทุกคำขอ

เปิดคอนโซลนักพัฒนา

สมัครขอ API key

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

รูปแบบสากล (+รหัสประเทศ…) หรือเบอร์ในประเทศพร้อมรหัสประเทศทางซ้าย จัดเก็บแบบเข้ารหัส

https พอร์ต 443 และโฮสต์สาธารณะเท่านั้น

IP สาธารณะหรือช่วง IPv4 ไม่กว้างกว่า /24 บรรทัดละหนึ่งรายการ สูงสุด 20 รายการ

การเรียก “Try it out” ของ Swagger ที่ลงนามในเบราว์เซอร์จะส่งจากพีซีของคุณ จึงต้องอนุญาต IP สาธารณะของเครื่องนั้น ใช้เฉพาะแซนด์บ็อกซ์ (dev/stage) และถูกปฏิเสธบนระบบจริง กฎเดียวกับ IP เซิร์ฟเวอร์ สูงสุด 10 รายการ

ที่นี่ไม่ต้องเลือกสิทธิ์ หลังได้รับอนุมัติ ให้ใช้คีย์ของคุณขอสิทธิ์ในคอนโซลนักพัฒนา

อย่างน้อย 20 ตัวอักษร

ทุกคำขอได้รับการตรวจสอบโดยผู้ดูแลของ AltoPocket

นักพัฒนา — Integrations API · AltoPocket