คู่มือเวิร์กโฟลว์ API

คุณต้องการสร้างอะไร?

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

ห้าเส้นทางที่นำไปใช้ได้จริง

เริ่มต้นด้วยผลลัพธ์ ไม่ใช่รายการ endpoint

Selected: Measure surprises

การทดลองใช้ API เป็นเวลา 14 วันของคุณ

เปลี่ยนจากการส่งคำขอครั้งแรกไปสู่งานที่มีคุณค่าและยั่งยืน

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

ตรวจสอบความคืบหน้าของ API

วัน 0

พิสูจน์การเข้าถึง

สร้างคีย์, ดำเนินการคำขอที่ผ่านการพิสูจน์ตัวตนหนึ่งครั้ง และบันทึกการตอบสนองครั้งแรกพร้อมกับเมทาดาตา

เปิดขั้นตอน →

วัน 1-2

ทำให้คำขอมีความน่าเชื่อถือ

แก้ไขปัญหาการยืนยันตัวตนหรือตัวกรอง และเปลี่ยนสคริปต์แรกให้เป็นงานที่ตั้งชื่อและทำซ้ำได้

เปิดขั้นตอน →

วัน 3-4

เพิ่มเวลาการประกาศ

ใช้ปฏิทินเป็นกลุ่ม endpoint ที่สองและกำหนดตารางการรัน API ที่มีประโยชน์ครั้งต่อไป

เปิดขั้นตอน →

วัน 5-7

สร้างผลลัพธ์การวิจัย

เพิ่มความคาดหวังหรือกลุ่มเล็กๆ ของชุดข้อมูล macro จากนั้นสร้างการเปรียบเทียบ, ตาราง หรือ scorecard ที่บันทึกไว้หนึ่งรายการ

เปิดขั้นตอน →

วันที่ 8-10

อัปเดตอัตโนมัติ

เลือก REST, SSE ที่กำหนดเวลาไว้ หรือ webhooks และดำเนินการรัน API ที่ประสบความสำเร็จอีกครั้งในวันอื่น

เปิดขั้นตอน →

วัน 11-13

เสริมความแข็งแกร่งให้ไคลเอนต์

เพิ่มการกำหนดเวลาหมดเวลา (timeouts), การลองใหม่แบบจำกัดจำนวน (bounded retries), การตรวจสอบความถูกต้องของการตอบสนอง, การบันทึกข้อมูลที่ปลอดภัยต่อข้อมูลประจำตัว และการตรวจสอบข้อมูลที่ล้าสมัย

เปิดขั้นตอน →

วัน 14

ตรวจสอบหลักฐาน

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

เปิดขั้นตอน →

Expectations workflow

Compare forecasts with actual releases

Use predictions before the event, preserve the forecast timestamp, then join the released observation by announcement identity for a repeatable surprise series.

20 minutes Research workflow การคาดการณ์การประกาศ

ตัวอย่างการทำงาน

เก็บคีย์ของคุณไว้ใน FXMD_API_KEY; ห้ามวางลงใน source control โดยเด็ดขาด

import os
import requests

params = {
    "api_key": os.environ["FXMD_API_KEY"],
    "pre_release_only": "true",
    "limit": 5,
}
response = requests.get(
    "https://api.fxmacrodata.com/v1/predictions/eur/inflation",
    params=params,
    timeout=20,
)
response.raise_for_status()
print(response.json()["data"][0])

ผลลัพธ์ที่คาดหวัง: Recent EUR inflation release groups with source-labelled forecasts that were recorded before each announcement.

เมื่อสคริปต์แรกกลายเป็นระบบจริง

การแก้ไขปัญหาและคำแนะนำระดับ production

ใช้คู่มือเหล่านี้เมื่อการตอบสนองล้มเหลว, ไม่คืนค่าข้อมูล หรือต้องการการควบคุมระดับ production เช่น การทำแคช, การกำหนดเวลาหมดเวลา, การลองใหม่ และการส่งเหตุการณ์

คู่มือใช้เมื่อเริ่ม
วินิจฉัยการตอบกลับที่ล้มเหลวหรือว่างเปล่า แยกปัญหาการยืนยันตัวตน, การเข้าถึง, เส้นทาง, การจำกัดอัตรา และความพร้อมใช้งานของข้อมูล โดยไม่เปิดเผยคีย์ของคุณ เปิดคู่มือ →
ทำให้ไคลเอนต์ API พร้อมสำหรับการผลิต เพิ่มการกำหนดเวลาหมดเวลา (timeouts), การลองใหม่แบบจำกัดจำนวน (bounded retries), การทำแคช, การร้องขอแบบมีเงื่อนไข และรูปแบบการส่งข้อมูลที่เหมาะสม เปิดคู่มือ →