API применяется для регистрации клиентов в системе, получения и изменения данных профиля, получения информации о покупках и бонусном балансе клиентов.
Более подробное описание методов API доступно по ссылке:
https://app.swaggerhub.com/apis-docs/Samarasoft/Personalarea/v1
Аутентификация
Для аутентификации запросов используется API токен. Для выполнения запросов, требующих аутентификацию, нужно передать токен в http заголовке Authorization. Например:
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjaWQiOiIyNjViN2VmMi0zZWYzLTRlZWYtYTRiNi05OWJmMzI0MDY0YmIiLCJleHAiOjE1NTg2ODExOTEsImlzcyI6IlBlcnNvbmFsQXJlYSIsImF1ZCI6IlBlcnNvbmFsQXJlYUNsaWVudCJ9.D0FkWDv5eCeQLJ64L_uXldex5WQf02JgPWr9Z1pif70
Ошибки
Если в процессе обработки запроса произойдет ошибка, API вернет объект ошибки и стандартный HTTP-код.
HTTP-коды, используемые в API
200 — Успешный запрос.
400 — Неправильный запрос. Чаще всего этот статус выдается из-за нарушения правил взаимодействия с API.
401 — Неверный токен доступа или отсутствует заголовок Authorization.
500 — На стороне сервиса что-то пошло не так. Результат обработки запроса неизвестен. Обратитесь к системному администратору.
Коды ошибок бизнес логики
"phone_or_email_required" - поля телефон или email обязательные для заполнения
"contact_already_exists" - контакт уже существует
"contact_not_found" - контакт не найден
"invalid_token" - некорректный токен авторизации
"phone_is_already_exist" - телефон уже привязан к другому контакту
Методы
- contact/create — создание контакта
- contact/edit — изменение контакта
- contact/info — получение данных контакта
- purchase/list — получение данных о покупках контакта
- contact/subscribe — подписка на рассылки по разным каналам
- contact/unsubscribe — отписка от рассылок
- contact/sendCode — отправка кода подтверждения телефона
- contact/checkCode — проверка кода подтверждения телефона
- bonus/list — получение информации о движении бонусных баллов