Duyệt tài liệu
Tham chiếu API
Tìm nguyên nhân của một yêu cầu sai và quyết định sửa nó, chờ hay thử lại.
Trên trang này
HTTP Trạng thái mã
Bắt đầu với trạng thái HTTP, rồi đọc mã lỗi và thông điệp cho nguyên nhân cụ thể.
| Trạng thái | Nghĩa là | Cách xử lý |
|---|---|---|
| 400 | Yêu cầu sai | Sửa chữa nguồn, trường cần thiết, kiểu tham số hoặc đầu đề trả lời trước khi thử lại. |
| 401 | Xác thực thất bại | Kiểm tra X-API-Key. Thay thế một phím đã hết hạn hoặc bị thu hồi; việc thử lại cùng một phím sẽ không giúp đỡ. |
| 402 | Tín dụng không đủ | Kiểm tra số dư tài khoản. Thêm tín dụng hoặc để cho người sở hữu tài khoản truy cập trước khi gửi lại. |
| 403 | Truy cập bị từ chối | Hãy kiểm tra quyền hạn và tài khoản mã nguồn của khóa, hoặc tình trạng đăng ký. |
| 404 | Không tìm thấy | Kiểm tra URLcông việc ID và tài khoản. Công việc ngoài tài khoản hay nguồn tin của bạn cũng có thể trả lại 404. |
| 406 | Không chấp nhận kiểu ứng phó | Dùng Accept: application/json hay text/plain. Chọn Markdown có X-Respond-WithĐánh dấu. |
| 409 | Kết quả chưa sẵn sàng hoặc xung đột | Kết quả là hãy xem xét kỹ công việc hiện có cho đến khi nó hoàn tất. Để giải quyết những vấn đề khác, hãy giải quyết những mâu thuẫn được miêu tả trong cơ thể. |
| 410 | Kết quả hết hạn | Dùng bản sao lưu đi. Đang thử lại kết quả URL không thể phục hồi kết quả đã hết hạn. |
| 422 | Công việc nhập/ thất bại không hợp lệ | Sửa chữa các cánh đồng đã báo cáo. Kết quả là đọc, thanh tra job.error: một công việc thất bại không đem lại kết quả nào thành công. |
| 429 | Tới hạn | Đợi Retry-After hay retry_after. Giảm tốc độ yêu cầu; để có hàng đợi đầy đủ, hãy đợi công việc đã có đến finish. |
| 500 / 502 / 503 / 504 | Dịch vụ hay thất bại theo dòng chảy | Hãy thử đọc lại với bị hạn chế lùi. Cho một POST hoặc nghỉ phép, hãy kiểm tra xem công việc được chấp nhận trước khi gửi lại. |
Đọc câu trả lời lỗi
API lỗi sử dụng JSON, bao gồm cả khi bạn yêu cầu một văn bản đơn giản. Cơ thể mỗi người mỗi lúc mỗi khác. Chi nhánh trên HTTP Khi có mặt, hãy dùng thông điệp hoặc chi tiết để giải thích vấn đề.
Truy vấn lỗi thường bao gồm lỗi và thông điệp; mã lệnh là tùy chọn. Lỗi xác thực có thể được dùng success: false thay vì error: true.
{
"error": true,
"code": "unsupported_representation",
"message": "X-Respond-With supports markdown. Omit the header for the original result fields."
}Đáp ứng vấn đề V2 sử dụng application/problem+json. Giữ requestId hỗ trợ. Thẩm tra lỗi cũng có thể bao gồm fieldErrors với lĩnh vực, mã và thông điệp.
{
"type": "https://api.flashdata.dev/problems/invalid_api_key",
"title": "Invalid API Key",
"status": 401,
"code": "invalid_api_key",
"requestId": "example-request-id",
"detail": "The API Key is invalid or unavailable."
}Kiểm tra tình trạng, đầu đề và cơ thể
Dùng curl --include để nhìn thấy cả ba. Ví dụ này kiểm tra phím của bạn bằng cách đọc tài khoản miễn phí; nó không gửi một yêu cầu. Đặt FLASHDATA_API_KEY trong môi trường của bạn đầu tiên.
curl --include --silent --show-error --max-time 20 \
'https://api.flashdata.dev/v2/api-access/identity' \
--header "X-API-Key: ${FLASHDATA_API_KEY:?Set FLASHDATA_API_KEY}" \
--header 'Accept: application/json'Khi nào cần thử lại
Một POST lặp đi lặp lại có thể tạo ra một yêu cầu có thể tính được. Thời hạn mạng không chứng minh yêu cầu đầu tiên bị từ chối. Lưu công việc ID Ngay khi anh nhận được nó.
| Tình trạng | Hành động tiếp theo |
|---|---|
| Nhập, khóa, cho phép hay số dư không hợp lệ | Dừng lại. Sửa tình trạng yêu cầu hay tài khoản trước khi thử lại; đừng lặp lại những lỗi này. |
| 429 với một gợi ý chờ | Danh dự Retry-After (sseconds or HTTP ngày), hay JSON retry_after giá trị trong vài giây. Nếu cả hai đều có mặt, hãy dùng sự chậm trễ lâu hơn. |
| Yêu cầu đọc: 429 / Lỗi mạng 5x / mạng tạm thời | Hãy thử lại cùng một GET. Không có gợi ý chờ, sử dụng sự chậm trễ ngày càng tăng với lo lắng, một sự cố gắng tối đa đếm và giới hạn thời gian. |
| POST Thời hạn hoặc mơ hồ 5x | Giữ công việc đã có ID và kiểm tra tình trạng của nó. Nếu không nhận được ID, hãy kiểm tra lịch sử công việc trước khi quyết định nộp lại. |
Kiểm tra một công việc nền
HTTP 200 Từ điểm kết thúc trạng thái có nghĩa là việc đọc đã thành công. Kiểm tra job.status để biết nhiệm vụ có thành công hay không. Đặt JOB_ID cho công việc đã có; lệnh này không gửi một lệnh thay thế.
| job.status | Cách xử lý |
|---|---|
| pending / processing | Đợi đã, sau đó bỏ phiếu cho cùng một công việc. Comment 409 Cho đến khi hoàn thành. |
| completed | Lấy lại và giữ lại kết quả. Gốc JSON Kết quả trả lại a 302 lưu trữ chuyển hướng; kết quả có thông tin trả về một thi thể trực tiếp. |
| failed | Đừng có bỏ phiếu và kiểm tra job.error. Kết quả điểm kết thúc trở lại 422 có mã result_not_ready cho một công việc thất bại. |
curl --fail-with-body --silent --show-error --max-time 30 \
"https://api.flashdata.dev/v2/jobs/${JOB_ID:?Set JOB_ID}" \
--header "X-API-Key: ${FLASHDATA_API_KEY:?Set FLASHDATA_API_KEY}" \
--header 'Accept: application/json'Lỗi định dạng
| Trạng thái / mã | Sửa |
|---|---|
| 400 · unsupported_representation | Đặt X-Respond-With để đánh dấu xuống, hoặc gỡ bỏ đầu trang. |
| 406 · not_acceptable | Đặt Accept phải application/json hay text/plain; sử dụng UTF-8 nếu chỉ ra một ký tự. |
Gọi trợ giúp với một yêu cầu
Gửi điểm kết thúc, nhãn thời gian của UTC, HTTP Trạng thái, mã lỗi và yêu cầu hay việc làm ID. Bỏ API chìa khóa, vật chứng và ký URLs từ báo cáo.