所有回复都有 application / json 内容类型,并遵循普遍接受的状态代码:

状态 描述
200 确定
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."
        ]
    }
}

返回 下一步