วัน 0
พิสูจน์การเข้าถึง
สร้างคีย์, ดำเนินการคำขอที่ผ่านการพิสูจน์ตัวตนหนึ่งครั้ง และบันทึกการตอบสนองครั้งแรกพร้อมกับเมทาดาตา
เปิดขั้นตอน →คู่มือเวิร์กโฟลว์ API
คุณต้องการสร้างอะไร?
เลือกผลลัพธ์ที่ใกล้เคียงกับงานของคุณที่สุด แต่ละเส้นทางจะให้คำขอที่ใช้งานได้หนึ่งรายการ, สิ่งที่การตอบสนองควรมี, วิธีตรวจสอบว่าทำงานได้ และขั้นตอนที่มีประโยชน์ถัดไป
ห้าเส้นทางที่นำไปใช้ได้จริง
เริ่มต้นด้วยผลลัพธ์ ไม่ใช่รายการ endpoint
เลือกแล้ว: ดึงข้อมูลมหภาค
เส้นทาง 1
ดึงข้อมูล macro
ดึงข้อมูลอนุกรมเวลาที่สะอาดและเก็บเมทาดาตาของแหล่งที่มาและคุณภาพไว้ควบคู่กัน
เส้นทาง 2
วางแผนงานการประกาศ
ใช้ปฏิทินการประกาศเพื่อรันงานที่กำหนดเป้าหมายรอบเวลาการเผยแพร่ที่ทราบ
เส้นทาง 3
วัดค่าความประหลาดใจ (surprises)
รวมการคาดการณ์ก่อนการประกาศเข้ากับค่าที่เผยแพร่โดยไม่ทำให้เกิด lookahead bias
เส้นทาง 4
รับการอัปเดตแบบสด
ใช้ SSE เป็นสัญญาณการยกเลิก จากนั้นดึงบันทึกที่สมบูรณ์จาก REST
เส้นทาง 5
สร้างแบบจำลองมหภาค
เปลี่ยนกลุ่มตัวบ่งชี้ที่เกี่ยวข้องขนาดเล็กให้เป็นสกอร์การ์ดสกุลเงินที่มีการระบุแหล่งที่มา
การทดลองใช้ API เป็นเวลา 14 วันของคุณ
เปลี่ยนจากการส่งคำขอครั้งแรกไปสู่งานที่มีคุณค่าและยั่งยืน
เป้าหมายไม่ใช่การเข้าชมทุกหน้าผลิตภัณฑ์ แต่คือการทำงานด้วย API ที่มีการยืนยันตัวตนอย่างมีประโยชน์ให้เสร็จสิ้น กลับมาอีกครั้งในวันอื่น และจากไปพร้อมกับชุดข้อมูลหรือเวิร์กโฟลว์แอปพลิเคชันที่ทำซ้ำได้
วัน 1-2
ทำให้คำขอมีความน่าเชื่อถือ
แก้ไขปัญหาการยืนยันตัวตนหรือตัวกรอง และเปลี่ยนสคริปต์แรกให้เป็นงานที่ตั้งชื่อและทำซ้ำได้
เปิดขั้นตอน →วัน 3-4
เพิ่มเวลาการประกาศ
ใช้ปฏิทินเป็นกลุ่ม endpoint ที่สองและกำหนดตารางการรัน API ที่มีประโยชน์ครั้งต่อไป
เปิดขั้นตอน →วัน 5-7
สร้างผลลัพธ์การวิจัย
เพิ่มความคาดหวังหรือกลุ่มเล็กๆ ของชุดข้อมูล macro จากนั้นสร้างการเปรียบเทียบ, ตาราง หรือ scorecard ที่บันทึกไว้หนึ่งรายการ
เปิดขั้นตอน →วันที่ 8-10
อัปเดตอัตโนมัติ
เลือก REST, SSE ที่กำหนดเวลาไว้ หรือ webhooks และดำเนินการรัน API ที่ประสบความสำเร็จอีกครั้งในวันอื่น
เปิดขั้นตอน →วัน 11-13
เสริมความแข็งแกร่งให้ไคลเอนต์
เพิ่มการกำหนดเวลาหมดเวลา (timeouts), การลองใหม่แบบจำกัดจำนวน (bounded retries), การตรวจสอบความถูกต้องของการตอบสนอง, การบันทึกข้อมูลที่ปลอดภัยต่อข้อมูลประจำตัว และการตรวจสอบข้อมูลที่ล้าสมัย
เปิดขั้นตอน →วัน 14
ตรวจสอบหลักฐาน
ยืนยันว่า API ให้งานที่ทำซ้ำได้ซึ่งทีมของคุณจะรักษาไว้ จากนั้นเลือกชุดข้อมูลหรือเวิร์กโฟลว์แอปพลิเคชันถัดไป
เปิดขั้นตอน →คำขอแรก
ดึงและบันทึกประวัติข้อมูลมหภาค
เริ่มต้นด้วยหนึ่งสกุลเงินและหนึ่งตัวชี้วัดที่คุณเข้าใจอยู่แล้ว สิ่งนี้จะทำให้การยืนยันตัวตน, รูปแบบการตอบสนอง, การแบ่งหน้า และการจัดเก็บข้อมูลตรวจสอบได้ง่ายก่อนที่คุณจะเพิ่มอนุกรมข้อมูลมากขึ้น
ตัวอย่างการทำงาน
เก็บคีย์ของคุณไว้ใน FXMD_API_KEY; ห้ามวางลงใน source control โดยเด็ดขาด
import os
import requests
response = requests.get(
"https://api.fxmacrodata.com/v1/announcements/eur/inflation",
params={"api_key": os.environ["FXMD_API_KEY"], "limit": 5},
timeout=20,
)
response.raise_for_status()
payload = response.json()
print(payload["data"][0])ผลลัพธ์ที่คาดหวัง: การตอบสนองของ 200 พร้อมข้อมูลการสังเกต inflation ของ EUR ล่าสุด พร้อมเมทาดาตาการตอบสนองที่อธิบายชุดข้อมูล, แหล่งที่มา, การแบ่งหน้า และคุณภาพของข้อมูล
เมื่อสคริปต์แรกกลายเป็นระบบจริง
การแก้ไขปัญหาและคำแนะนำระดับ production
ใช้คู่มือเหล่านี้เมื่อการตอบสนองล้มเหลว, ไม่คืนค่าข้อมูล หรือต้องการการควบคุมระดับ production เช่น การทำแคช, การกำหนดเวลาหมดเวลา, การลองใหม่ และการส่งเหตุการณ์
| คู่มือ | ใช้เมื่อ | เริ่ม |
|---|---|---|
| วินิจฉัยการตอบกลับที่ล้มเหลวหรือว่างเปล่า | แยกปัญหาการยืนยันตัวตน, การเข้าถึง, เส้นทาง, การจำกัดอัตรา และความพร้อมใช้งานของข้อมูล โดยไม่เปิดเผยคีย์ของคุณ | เปิดคู่มือ → |
| ทำให้ไคลเอนต์ API พร้อมสำหรับการผลิต | เพิ่มการกำหนดเวลาหมดเวลา (timeouts), การลองใหม่แบบจำกัดจำนวน (bounded retries), การทำแคช, การร้องขอแบบมีเงื่อนไข และรูปแบบการส่งข้อมูลที่เหมาะสม | เปิดคู่มือ → |