Общие ошибки авторизации и валидации в API

Читать 4

Ошибки авторизации

Для разных API методов код ответа и тело ответа в случае ошибки могут отличаться.

Ниже указаны все варианты ошибочных ответов в разных случаях проблем с авторизацией.


В API запросе не был передан API токен.

1) Код ответа 403

{
    "meta":[],
    "data":{
        "message":"Не указан token"
    }
}

2) Код ответа 403

{
    "meta":[],
    "data":{
        "message":"Ошибка доступа"
    }
}

3) Код ответа 403

{
    "meta":[],
    "data":{
    "type":"apiAuthError",
    "apiAuthErrorData":{
        "errorMessage":"Ошибка доступа. Не указан Access-Token."}
    }
}

 

В API запросе был передан некорректный или неактивный API токен.

1) Код ответа 403

{
    "message":"Invalid credentials."
}

2) Код ответа 403

{
    "meta":[],
    "data":{
    "type":"apiAuthError",
    "apiAuthErrorData":{
        "errorMessage":"Ошибка доступа. Некорректный Access-Token."}
    }
}


В API запросе не был передан SiteId или SiteIds.

1) Код ответа 403

{
    "meta":[],
    "data":{
    "type":"apiAuthError",
    "apiAuthErrorData":{
        "errorMessage":"Ошибка доступа. Не указан SiteId."}
    }
}

 

В API запросе был передан некорректный SiteId или SiteIds.

1) Код ответа 400

{
    "meta": [],
    "data": {
        "type": "apiError",
        "apiErrorData": {
            "errorCode": 6,
            "errorMessage": "Некорректный идентификатор сайта"
        }
    }
}

2) Код ответа 403

{
    "meta":[],
    "data":{
    "type":"apiAuthError",
    "apiAuthErrorData":{
        "errorMessage":"Ошибка доступа. Некорректный SiteId."}
    }
}

 

Переданный Access-Token не имеет прав доступа к кабинету SiteId или прав доступа по работе с API кабинетом SiteId.

1) Код ответа 400

{
    "meta": [],
    "data": {
        "type": "apiError",
        "apiErrorData": {
            "errorCode": 5,
            "errorMessage": "Нет доступа к сайту"
        }
    }
}

2) Код ответа 403

{
    "meta":[],
    "data":{
        "type":"apiAuthError",
        "apiAuthErrorData":{
            "errorMessage":"Ошибка доступа. Нет прав доступа в SiteId."
        }
    }
}


Передача данных по API отключена в настройках проекта.

1) Код ответа 400

{
    "meta":[],
    "data":{
        "type":"apiError",
        "apiErrorData":{
            "errorCode":2,
            "errorMessage":"Передача данных по API отключена в настройках сайта",
        }
    }
}


Кабинет SiteId неактивен.

1) Код ответа 400

{
    "meta":[],
    "data":{
        "type":"apiError",
        "apiErrorData":{
            "errorCode":3,
            "errorMessage":"Сайт не активирован.",
            "errorSiteIds":[SiteId]
        }
    }
}


Ошибки валидации полей API запроса

В разных API запросах в связи с их спецификой могут быть дополнительные варианты ответов по ошибкам валидации. Если такие ответы возможны - их описание указано в справке по конкретным API методам.

Ниже указаны все типовые ответы в случаях проблем с валидацией данных в API запросе. 


Обязательное поле не было передано в API запросе.

1) Код ответа 400

{
    "meta": [],
    "data":{
        "message": "В запросе не указано обязательное поле fieldName
    }
}

 

Ошибка валидации содержимого поля в API запросе.

1) Код ответа 400

{
    "meta": [],
    "data": {
        "type": "validationError",
        "validationErrorData": {
            "violations": [
                {
                    "fieldPath": "Указание на ошибочное поле",
                    "message": "Описание в чем именно ошибка"
                }
            ]
        }
    }
}

 

 

Не нашли решение проблемы?
Заполните форму, и мы вам поможем.
х
Заполните форму
и мы поможем вам
Похожие статьи
Недавно просмoтренные