모든 응답은 신청 / json 컨텐츠 유형이 포함되며 일반적으로 허용된 상태 코드를 따릅니다:

상태 설명
200 OK
401 잘못된 API 키
403 접근 불가
404 찾을 수 없음
405 허용되지 않은 방법
422 처리 할 수없는 엔터티
500 내부 서버 오류

성공적인 응답 데이터는 다음과 같이 언제나 데이터 키로 제공됩니다:

{
    "data": {
        "id": 123,
        "name": "Example",
        "active": true
    }
}

페이지 당 데이터 배열을 반환할 수 있습니다:

{
    "data": [],
    "links": {
        "first": "https://simex.global/api/example?page=1",
        "last": "https://simex.global/api/example?page=5",
        "prev": "https://simex.global/api/example?page=2",
        "next": "https://simex.global/api/example?page=4"
    },
    "meta": {
        "current_page": 3,
        "from": 31,
        "last_page": 5,
        "path": "https://simex.global/api/example",
        "per_page": 15,
        "to": 45,
        "total": 75
    }
}

4** 코드 오류가 발생한 경우 다음과 같이 메시지가 키 메시지에 제시됩니다:

{
    "message": "Unauthenticated."
}

422 - 유효하지 않은 요청 응답 예시:

{
    "message": "The given data was invalid.",
    "errors": {
        "pair": [
            "The pair field is required."
        ]
    }
}

뒤로 다음