문서 둘러보기
API 참조
실패한 요청의 원인을 찾아서 수정, 대기 또는 재발을 결정하십시오.
이 페이지의 내용
HTTP 상태 코드
HTTP 상태로 시작하면 오류 코드와 특정 원인에 대한 메시지를 읽습니다.
| (주) | 은둔 | 해결 방법 |
|---|---|---|
| 400 | 잘못된 요청 | retrying 전에 소스, 필수 필드, 매개 변수 유형 또는 응답 헤더를 수정합니다. |
| 401 | 인증 실패 | X-API-Key를 확인하십시오. 만료된 키를 교체하거나 수정; 동일한 키를 다시 복원하는 것은 도움이되지 않습니다. |
| 402 | 충분한 크레딧 | 계정 잔액 확인. 크레딧을 추가하거나 계정 소유자가 다시 제출하기 전에 액세스 할 수 있도록합니다. |
| 403 | 접근 거부 | 키의 소스 권한 및 계정 또는 구독 상태를 확인하십시오. |
| 404 | 더 많은 정보 | URL, ID 및 계정 확인. 허용 된 계정 또는 소스 이외의 작업은 404를 반환 할 수 있습니다. |
| 406 | 응답 유형 수락가능한 | Accept를 사용하십시오: application/json 또는 text/plain. X-Respond-With: Markdown을 사용하여 Markdown를 선택하십시오. |
| 409 | 결과 준비 / 충돌 | 결과에 읽힌 결과, 그 결과가 완료 될 때까지 기존의 일자리를 조사합니다. 다른 종점의 경우, 몸에 설명된 충돌을 해결합니다. |
| 410 | 결과가 만료됨 | 저장된 사본을 사용하십시오. 결과 재량 URL는 만료된 결과를 복원할 수 없습니다. |
| 422 | 잘못된 입력 / 실패 작업 | 보고된 필드를 수정합니다. 결과에 job.error를 검사합니다. 실패한 작업은 fetch에 성공한 결과가 없습니다. |
| 429 | 제한 도달 | Retry-After 또는 retry_after에 대한 대기. 요청률을 줄입니다. 전체 보류의 경우 기존 작업에 finish를 기다립니다. |
| 500 / 502 / 503 / 504 | 서비스 또는 상류 실패 | Retry는 바인딩 된 백 오프로 읽습니다. POST 또는 제출 타임아웃의 경우, 작업이 다시 전송하기 전에 허용되었는지 확인하십시오. |
오류 응답 읽기
API 오류는 일반 텍스트를 요청할 때 JSON를 사용합니다. 몸은 endpoint에 의해 다릅니다. HTTP 상태 및 코드의 지점은 현재; 문제를 설명하기 위해 메시지 또는 세부 사항을 사용합니다.
Query 오류는 일반적으로 오류 및 메시지가 포함됩니다. 코드는 선택 사항입니다. 인증 오류는 error: true 대신 success: false를 사용할 수 있습니다.
{
"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."
}Inspect 상태, 우두머리 및 몸
curl --include를 사용하여 모든 3을 볼 수 있습니다. 이 예제는 무료 계정 읽기와 키 확인; 그것은 쿼리를 제출하지 않습니다. 환경에 있는 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 / 임시 5xx / 네트워크 오류 | 동일한 GET를 재시동합니다. 대기 힌트없이, 지터와 지연을 증가, 최대 시도 수 및 시간 제한. |
| POST 타임 아웃 또는 주변 5xx | 기존 작업 ID를 유지하고 상태를 확인합니다. ID가 수신되지 않은 경우, 다시 제출하기 전에 작업 기록을 검사합니다. |
배경을 확인
HTTP 200는 상태 종료점에서 읽힌 성공을 의미합니다. job.status를 확인하여 작업이 성공했는지 알 수 있습니다. 기존 작업에 JOB_ID를 설정하십시오. 이 명령은 교체를 제출하지 않습니다.
| job.status | 해결 방법 |
|---|---|
| pending / processing | 대기,다음 동일한 작업을 poll. 결과가 완료 될 때까지 409를 반환합니다. |
| completed | 결과를 검색하고 저장합니다. Original 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'응답 정보 오류
| 상태 / 코드 | 해결 |
|---|---|
| 400 · unsupported_representation | X-Respond-With를 마쳐 놓거나 헤더를 제거하십시오. |
| 406 · not_acceptable | Accept를 application/json 또는 text/plain로 설정하십시오. charset를 지정하면 UTF-8를 사용하십시오. |
자주 묻는 질문
엔드포인트, UTC 타임스탬프, HTTP 상태, 오류 코드 및 요청 또는 작업 ID를 전송합니다. API 키, 토큰을 제거하고 보고서에서 URLs를 서명했습니다.