เรียกดูเอกสาร
เอกสารอ้างอิง API
ค้นหาสาเหตุของการร้องขอล้มเหลว และตัดสินใจว่าจะแก้ไขมันหรือไม่ ให้รอหรือพยายามใหม่
ในหน้านี้
HTTP รหัสสถานะ
เริ่มจาก HTTP สถานะ อ่าน รหัส ผิด และ ข้อ ความ สําหรับ สาเหตุ เฉพาะ.
| สถานะ | หมายความว่า | วิธีแก้ไข |
|---|---|---|
| 400 | การร้องขอไม่ถูกต้อง | แก้ไขแหล่งข้อมูล, ต้องการช่องข้อมูล, ชนิดพารามิเตอร์ หรือส่วนหัวแบบตอบกลับ ก่อนที่จะทําการแก้ไข |
| 401 | การตรวจสอบสิทธิ์ล้มเหลว | เช็ค X-API-Key แทนที่กุญแจที่หมดอายุแล้วหรือถูกยกเลิก การพยายามใช้ปุ่มพิมพ์เดียวกันจะไม่ช่วย |
| 402 | เครดิตไม่เพียงพอ | เช็คยอดบัญชีสิ เพิ่มเครดิตหรือให้เจ้าของบัญชีผู้ใช้แก้ไขสิทธิ์ในการเข้าใช้ก่อนการส่งข้อมูลอีกครั้ง |
| 403 | ถูกปฏิเสธการเข้าใช้งาน | โปรดตรวจสอบสิทธิ์ที่อนุญาตของกุญแจ และสถานะบัญชีผู้ใช้หรือจํานวนสมาชิก |
| 404 | ไม่พบ | เช็คดูสิ URL# งาน... ID และบัญชี งานนอกบัญชีที่อนุญาต หรือแหล่งกําเนิดของคุณยังสามารถคืน 404 ได้ด้วย |
| 406 | ชนิดของการตอบสนองไม่สามารถยอมรับได้ | ใช้ Accept: application/json หรือ text/plain. เลือก Markdown ด้วย X-Respond-Withนับถอยหลัง |
| 409 | ผลไม่พร้อม/ ขัดแย้ง | ผล ก็ คือ จง สํารวจ งาน ที่ มี อยู่ จน กว่า จะ เสร็จ สมบูรณ์. สําหรับ จุด จบ อื่น ๆ จง แก้ ข้อ ขัด แย้ง ที่ พรรณนา ไว้ ใน ร่าง กาย. |
| 410 | ผลการหมดอายุ | ใช้สําเนาที่บันทึกไว้ การ พยายาม ให้ ได้ ผล URL ไม่สามารถเรียกคืนผลลัพธ์ที่หมดอายุแล้วได้ |
| 422 | งานนําเข้า/ ล้มเหลว | ซ่อมที่รายงานมา เมื่ออ่านผลแล้ว ให้ตรวจสอบ job.error: งานที่ล้มเหลวไม่มีผลสําเร็จที่จะดาวน์โหลด |
| 429 | มีข้อจํากัด | รอ Retry-After หรือ retry_after. ลดอัตราการร้องขอลง; สําหรับคิวที่ทํางานอยู่เต็มรูปแบบ ให้รองานที่มีอยู่แล้วไปยัง finish. |
| 500 / 502 / 503 / 504 | การบริการหรือการเพิ่มความเร็วล้มเหลว | ลองอ่านใหม่พร้อมฉากหลัง สําหรับ POST หรือ ไม่ ก็ เวลา หมด ไป ด้วย การ ส่ง เช็ค ดู ว่า มี การ ยอม รับ งาน ไหม ก่อน จะ ส่ง อีก. |
การอ่านการตอบรับผิดพลาด
API ใช้ข้อผิดพลาด JSON. รวมถึงเมื่อคุณร้องขอข้อความธรรมดา ร่างกายต่างกันโดยจุดปลาย แบรนช์ใน HTTP สถานะ และ รหัส เมื่อ อยู่ ที่ นั่น; ใช้ ข้อ ความ หรือ ราย ละเอียด เพื่อ อธิบาย ปัญหา.
สืบค้นข้อผิดพลาดโดยทั่วไปรวมถึงข้อผิดพลาดและข้อความ; รหัสเป็นตัวเลือก การตรวจสอบสิทธิ์อาจจะใช้ข้อผิดพลาด success: false แทน error: true.
{
"error": true,
"code": "unsupported_representation",
"message": "X-Respond-With supports markdown. Omit the header for the original result fields."
}V2 การตอบสนองปัญหาโดยใช้ application/problem+json เก็บไว้ requestId เพื่อการสนับสนุน การตรวจสอบข้อผิดพลาดอาจจะรวม fieldErrors กับสนาม รหัสและข้อความ
{
"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."
}แสดงสถานะ, ส่วนหัวและตัวบุคคล
ใช้ curl --include เพื่อดูทั้งสาม ตัวอย่างนี้ จะทําการตรวจสอบกุญแจของคุณด้วยการอ่านบัญชีผู้ใช้เสรี; มันไม่ได้ส่งคําค้น ตั้ง FLASHDATA_API_KEY ในสภาพแวดล้อมของคุณก่อน
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'เมื่อต้องการลองใหม่
ซ้ํา POST สามารถสร้างข้อพิพาทอื่นได้ หมดเวลาของเครือข่าย ไม่พิสูจน์ว่าคําขอแรกถูกปฏิเสธ บันทึกงาน ID ทันทีที่คุณได้รับ
| สถานการณ์ | การกระทําถัดไป |
|---|---|
| ค่านําเข้า, กุญแจ, ค่าอนุญาตหรือค่าสมดุลไม่ถูกต้อง | หยุด แก้ไขการร้องขอหรือสถานะบัญชีผู้ใช้ก่อนที่จะทําการลองใหม่ อย่าวนรอบข้อผิดพลาดเหล่านี้ |
| 429 โดยมีคําใบ้รอ | เกียรติ Retry-After (วินาทีหรือ HTTP วัน, หรือ วัน JSON retry_after ค่าในวินาที ถ้า ทั้ง สอง อยู่ ด้วย จง ใช้ เวลา ล่า ช้า กว่า. |
| ร้องขออ่าน: 429 / ชั่วคราว 5x/ เครือข่ายผิดพลาด | ลองใหม่อีกครั้ง GET หากไม่มีคําใบ้ให้รอ ให้ใช้การหน่วงเวลาที่เพิ่มมากขึ้น โดยใช้การเรียกดู เพิ่มเป็นจํานวนครั้งที่เริ่มแล้ว และจํากัดเวลาด้วย |
| POST เวลานอกหรือคลุมเครือ 5x | ให้งานที่มีอยู่ ID และตรวจสอบสถานะของมัน หากไม่มี ID ให้ตรวจสอบประวัติงานก่อนที่จะตัดสินใจส่งอีกครั้ง |
ตรวจสอบงานเบื้องหลัง
HTTP 200 จากสถานะจุดปลาย หมายถึงการอ่านประสบความสําเร็จ ตรวจสอบ job.status เพื่อทราบว่างานนี้ประสบความสําเร็จหรือไม่ ตั้งค่า JOB_ID ไปยังงานของคุณอยู่แล้ว คําสั่งนี้จะไม่ส่งผู้แทนที่
| job.status | วิธีแก้ไข |
|---|---|
| pending / processing | เดี๋ยว, แล้วสํารวจงานเดิม ผลที่อ่านแล้ว 409 จนกว่าจะเสร็จ |
| completed | รับและบันทึกผลลัพธ์ เดิม JSON ผลลัพธ์ที่ส่งกลับมา 302 การจัดเก็บผลส่งออก; ส่งผลให้คืนค่าร่างกายได้โดยตรง |
| failed | หยุดสํารวจและตรวจสอบ job.error ฟังก์ชันผลลัพธ์ที่ได้มา 422 ด้วยรหัส result_not_ready สําหรับงานที่ล้มเหลว |
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'ข้อผิดพลาดในการปรับเทียบข้อมูลformat
| สถานะ / รหัส | แก้ไข |
|---|---|
| 400 · unsupported_representation | ตั้งค่า X-Respond-With เพื่อทําการทําเครื่องหมาย หรือลบส่วนหัว |
| 406 · not_acceptable | ตั้งค่า Accept ถึง application/json หรือ text/plain. ใช้ UTF-8 หากระบุชุดรหัสอักขระ |
ขอความช่วยเหลือด้วยคําขอ
ส่งจุดปลาย, UTC timetamp HTTP สถานะ, รหัสผิดพลาด และการร้องขอหรืองาน ID. ลบ API กุญแจ, ป้ายและลายเซ็น URLs จากรายงาน