Справочный центр Wialon

Получение токена доступа

Командой Gurtam был создан более защищённый механизм авторизации по принципу oAuth. Предыдущий способ авторизации core/login был действителен до 1 октября 2015 года. Клиентам (партнёрам), которые реализовали свои формы входа на сайт мониторинга или использовали ссылки для демо-логина, нужно будет перейти на новый механизм авторизации.

В настоящее время существуют два варианта формы: расширенная и упрощённая.

Расширенная форма

Расширенная форма предназначена для мобильных и иных приложений.

Copied!
http://<host>/login.html
Copied!
http://<host>/login.html?client_id=...&access_type=...&activation_time=...&duration=...&lang=...&flags=...&user=...&redirect_uri=...&response_type=...&css_url=...

Параметры

Все параметры необязательны.

Имя Описание Значение по умолчанию
client_id Название приложения/сайта/клиента, для которого вы хотите сгенерировать токен. Название сайта (title).
access_type Уровень прав токена 0x100
activation_time Время активации токена. UTC время в секундах: 0 — сейчас. 0
duration Срок действия токена в секундах. Установите 0 для неограниченного срока действия.
Если токен не используется в течение 100 дней, он автоматически удаляется.
2592000
(30 дней в секундах).
lang Язык (en, ru и т. д.).
flags См. ниже. 0
user Имя пользователя. Будет в поле логина.
redirect_uri URL, на который переадресовать страницу и передать результаты авторизации. сама форма login.html
response_type Ответ будет содержать токен (token) или AuthHash (hash). token
css_url URL к CSS-файлу с произвольными стилями для формы.

Флаги

Флаг Описание
0x1 Вернуть user_name в ответе.
0x2 Вернуть в ответе:
  • client_id
  • access_type (если response_type=token),
  • activation_time,
  • duration,
  • flags,
  • response_type,
  • svc_error.

0x4 Вернуть все параметры из запроса, исключая зарезервированные (client_id, response_type, access_type, activation_time, duration, flags, login, passw, redirect_uri, p, app, sign, hash, remote_hash).

После успешной авторизации происходит перенаправление на redirect_uri, и передаются следующие GET-параметры:

  • access_token (72-значный токен, который можно сохранить и использовать для авторизации в дальнейшем);
  • user_name (имя авторизованного пользователя, если перед генерацией токена был указан флаг 0x1).

В случае ошибки авторизации происходит перенаправление на саму форму логина, показывается указанная ошибка и передаются следующие GET-параметры:

  • svc_error (код ошибки);
  • client_id;
  • access_type;
  • activation_time;
  • duration;
  • flags.

После получения 72-значного токена вы можете использовать его в своих приложениях для авторизации, используя метод token/login:

Copied!
svc=token/login&params={"token":"<access_token>","operateAs":"<optional_sub_user>"}

Упрощенная форма

Форма предназначена для простого встраивания на сайты (сайты-визитки) через iframe и дальнейшего быстрого перехода на один или несколько своих сайтов мониторинга после авторизации. По-умолчанию будет сформирована ссылка на сайт мониторинга. Также можно добавить ссылки на другие сайты (используя cms_url, lite_url, mobile_url, demo_url).

Copied!
http://<host>/login_simple.html
Copied!
http://<host>/login_simple.html?lang=...&cms_url=...&cms_title=...&lite_url=...&mobile_url=...&demo_title=...&demo_url=...&title=...&css_url=...

Параметры

Все параметры являются необязательными.

Имя Описание
lang Язык (en, ru и т. д.).
cms_url URL к сайту CMS Manager (например, http://cms.wialon.com). Если указан, он будет добавлен в список сайтов для быстрого перехода.
cms_title Название ссылки для CMS Manager.
mobile_url URL к сайту Wialon Mobile (например, http://m.wialon.com).
mobile_title Название ссылки для Wialon Mobile.
title Название ссылки для сайта мониторинга.
demo_url URL для демо-доступа (например, http://hosting.wialon.com/?token=<token>).
demo_title Название ссылки для демо-доступа.
css_url URL к CSS-файлу с указанными стилями для формы.

Если вы заметили ошибку в тексте, пожалуйста, выделите её и нажмите Ctrl+Enter.

Сообщить об ошибке

Ваше сообщение отправлено. Спасибо!

Произошла ошибка при отправке формы