Константы:
RSS_MAIL = 1 - информацию отправлять на e-mail
RSS_TG = 2 - todo на телеграмм
RSS_PUSH = 4 - todo push в браузер
HTTP_SUCCESS = 200 - успешно
HTTP_CREATED = 201 - объект создан
HTTP_NO_CONTENT = 204 - нет данных, ответ на запрос пуст
HTTP_MOVED_PERMANENTLY = 301 - переадресация на указанный адрес в поле location
HTTP_MOVED_TEMPORARILY = 302 - временная переадресация на указанный адрес в поле location
HTTP_SEE_OTHER = 303 -
HTTP_NEED_SEND_POST_TO_URL = 303 -
HTTP_BAD_REQUEST = 400 - неверный запрос
HTTP_UNAUTHORIZED = 401 - требуется авторизация
HTTP_PAYMENT_REQUIRED = 402 - необходима оплата
HTTP_FORBIDDEN = 403 - недоступно
HTTP_NOT_FOUND = 404 - объект не найден
HTTP_METHOD_NOT_ALLOWED = 405 - метод не поддерживается или не хватает параметров, в error описание проблемы
HTTP_NOT_ENOUGH_DATA = 422 - недостаточно данных для выполнения запроса, список недостающих данных передан в поле inputs
HTTP_TOO_MANY_REQUESTS = 429 - Превышен лимит запросов
HTTP_PERMISSION_DENIED = 550 - нет прав доступа к данному объекту
https://harlik.com/api.php?obj=User&m=logout
разрегистрация
ret_path - куда перейти
https://harlik.com/api.php?obj=User&m=reowner
войти под пользователем
доступно только админу
входные параметры:
id - под кем входим
https://harlik.com/api.php?obj=User&m=fromEmail
Подтверждение электронного адреса или переход из письма на смену пароля
Метод должен вызываться интерфейсом по ссылке типа: mydomen.com?obj=user&m=fromEmail&name=myLogin&mid=39965480&id=myUserId
после выполнения действий перебрасывает пользователя в профиль
https://harlik.com/api.php?obj=User&m=union
объединение пользователей
вызывается из sprav по obj=user&m=union&id=161&from=815&html&api
https://harlik.com/api.php?obj=User&m=login
Авторизация пользователя
Принцип построения ответа:
$ret_val['status'] общий статус выполнения запроса.
Для авторизации по-умолчанию 401,
если прошло удачно 200,
если не хватает данных 422
$ret_val['error'] текст общей ошибки
$ret_val['form_errors']['имя поля'][] конкретная ошибка поля ввода. В одном поле может быть несколько ошибок
$inputs[] линейный массив с указанием какие поля ввода должен сформировать интерфейс для удовлетворения входных условий метода
$inputs[] может находится в корне ответа - это знак для интерфейса, что форму рисовать в текущем контексте
$ret_val['dialog'] - сигнал интерфейсу, что нужно создать диалоговое окно в которое рендерить содержимое массива
https://harlik.com/api.php?obj=User&m=isbusy
проверка занятости имени
принимает name,mail,tel
https://harlik.com/api.php?obj=User&m=register
регистрация
сюда же попадаю при добавлении нового пользователя из под админа
https://harlik.com/api.php?obj=User&m=remember
переход из формы восстановления
https://harlik.com/api.php?obj=User&m=sendmail
переход по ссылке "запросить повторно письмо"
должен быть залогинен
https://harlik.com/api.php?obj=User&m=del
удалить пользователя
https://harlik.com/api.php?obj=User&m=save
сохранение изменений анкеты
https://harlik.com/api.php?obj=User&m=unsubscribe
Отписка от всего, включая callback
Входные параметры:
unsubscribe = e-mail
hash = код
all = если установлен, то от всего
call_back - только от call_back
unconfirm - пометить почту неподтвержденной
https://harlik.com/api.php?obj=User&m=banit
Баним по ip(только админ)
Входные параметры:
banit = ip = кого баним
msg - за что, не обязательно
https://harlik.com/api.php?obj=User&m=callme
Запрос из формы обратной связи
phone, email
name - Контактное лицо
text - Комментарий
https://harlik.com/api.php?obj=User&m=checkauth
Авторизация из 1С
phone, email
name - Контактное лицо
text - Комментарий
https://harlik.com/api.php?obj=User&m=pass_change
Изменение пароля
pass_old - старый пароль
pass1 - новый пароль
user - Если изменяет пароль админ
https://harlik.com/api.php?obj=User&m=api_key_new
Генерация нового ключа доступа
https://harlik.com/api.php?obj=User&m=export
Экспорт контактов в формате Google contacts для загрузки в Google https://contacts.google.com/ - Импортировать
Параметры:
tbl- по какой таблице сузить выборку, в ней должно быть поле user. Если не указано, выгружаются все контакты