Hướng dẫn quy trình làm việc API

Bạn muốn xây dựng điều gì?

Chọn kết quả gần nhất với công việc của bạn. Mỗi lộ trình cung cấp cho bạn một yêu cầu hoạt động, nội dung phản hồi nên có, cách kiểm tra xem nó có hoạt động hay không và bước hữu ích tiếp theo.

Năm lộ trình thực tế

Bắt đầu với kết quả, không phải danh sách endpoint.

Selected: Measure surprises

Bản dùng thử API trong 14 ngày của bạn

Chuyển từ yêu cầu đầu tiên sang một công việc đáng để duy trì.

Mục tiêu không phải là truy cập mọi trang sản phẩm. Mục tiêu là hoàn thành công việc API có xác thực hữu ích, quay lại vào một ngày khác, và rời đi với một tập dữ liệu hoặc quy trình ứng dụng có thể lặp lại.

Kiểm tra tiến độ API

Ngày 0

Chứng minh quyền truy cập

Tạo khóa, hoàn thành một yêu cầu đã xác thực và lưu phản hồi đầu tiên cùng với siêu dữ liệu của nó.

Mở bước →

Ngày 1-2

Làm cho yêu cầu trở nên đáng tin cậy

Giải quyết các vấn đề xác thực hoặc bộ lọc và chuyển đổi tập lệnh đầu tiên thành một công việc có tên có thể lặp lại.

Mở bước →

Ngày 3-4

Thêm thời điểm phát hành

Sử dụng lịch như một họ endpoint thứ hai và lên lịch cho lần chạy API hữu ích tiếp theo.

Mở bước →

Ngày 5-7

Xây dựng kết quả nghiên cứu

Thêm các kỳ vọng hoặc một nhóm nhỏ các chuỗi vĩ mô, sau đó tạo một bảng so sánh, bảng hoặc thẻ điểm đã lưu.

Mở bước →

Ngày 8-10

Tự động hóa các bản cập nhật

Chọn REST, SSE theo lịch trình, hoặc webhooks và hoàn thành một lần chạy API thành công khác vào một ngày khác.

Mở bước →

Ngày 11-13

Thắt chặt client

Thêm thời gian chờ, thử lại có giới hạn, xác thực phản hồi, ghi nhật ký an toàn thông tin xác thực và giám sát dữ liệu cũ.

Mở bước →

Ngày 14

Xem xét bằng chứng

Xác nhận rằng API cung cấp một công việc có thể lặp lại mà đội ngũ của bạn sẽ duy trì, sau đó chọn tập dữ liệu hoặc quy trình ứng dụng tiếp theo.

Mở bước →

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 dự báocông bố

Ví dụ hoạt động

Giữ khóa của bạn trong FXMD_API_KEY; không bao giờ dán nó vào hệ thống quản lý nguồn (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])

Kết quả mong đợi: Recent EUR inflation release groups with source-labelled forecasts that were recorded before each announcement.

Khi tập lệnh đầu tiên trở thành một hệ thống thực sự

Khắc phục sự cố và hướng dẫn sản xuất

Sử dụng các hướng dẫn này khi phản hồi thất bại, không trả về dữ liệu hoặc cần các kiểm soát sản xuất như bộ nhớ đệm, thời gian chờ, thử lại và phân phối sự kiện.

Hướng dẫnSử dụng nó khiBắt đầu
Chẩn đoán phản hồi bị lỗi hoặc trống Phân tách các vấn đề xác thực, truy cập, đường dẫn, giới hạn tốc độ và tính khả dụng của dữ liệu mà không làm lộ khóa của bạn. Mở hướng dẫn →
Chuẩn bị một client API cho môi trường sản xuất Thêm timeout, thử lại có giới hạn, bộ nhớ đệm, yêu cầu có điều kiện và mô hình phân phối phù hợp. Mở hướng dẫn →