Параметра




Скачать 63.79 Kb.
НазваниеПараметра
Дата публикации15.08.2013
Размер63.79 Kb.
ТипДокументы
vbibl.ru > Информатика > Документы

Выполнение запросов к API


Для того чтобы вызвать метод API iBlocker, необходимо осуществить POST или GET запрос по протоколу HTTPS на указанный URL:

https://api.iblocker.com/method/METHOD_NAME?PARAMETERS&access_token=ACCESS_TOKEN

METHOD_NAME – название метода из списка функций API,

PARAMETERS – параметры соответствующего метода API,

ACCESS_TOKEN – ключ доступа, полученный в результате успешной авторизации приложения.
Пример:

https://api.ibloker.com/method/phone.GetAccountPhoneNumbers?uid=66748&access_token=533bacf01e11f55b536a565b57531ac114461ae8736d6506a3


В ответ на такой запрос Вы получите ответ в формате JSON.
Для того чтобы получить ответ в формате XML, необходимо добавить расширение формата после названия метода, METHOD_NAME.xml


https://api.ibloker.com/method/phone.GetAccountPhoneNumbers.xml?uid=66748&access_token=533bacf01e11f55b536a565b57531ac114461ae8736d6506a3



Ниже приведены все методы для работы с данными iBlocker.

Пользователи


user.create – регистрация нового пользователя. В случае успеха возвращается идентификатор пользователя и токен.
user.auth – авторизация пользователя, возвращается токен для сессии.
user.forgetPass – отправляет email пользователю с инструкцией по восстановлению пароля.


user.Create (HTTP POST)


Регистрация нового пользователя.

Параметры


Название параметра

Обязательный параметр

Описание

name

да

Имя пользователя.

password

да

Пароль пользователя.

email

да

Email пользователя. Используется для восстановления пароля.


Результат


В случае успеха возвращается идентификатор созданного пользователя и токен.

Пример ответа в формате XML








1

533bacf01e11f55b536a565b57531ac114461ae8736d6506a3






Пример ответа в формате JSON


{
   "user":
      {
         "id":1,
         "token":"533bacf01e11f55b536a565b57531ac114461ae8736d6506a3"

      }
}


Коды ошибок


Код ошибки

Описание

1

Неизвестная ошибка

2

Ошибка на сервере

3

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

4

Формат данных не верный

5

Один из параметров имеет неправильное значение или отсутствует

6

Пользователь с таким именем уже существует.

7

Пароль слишком короткий.

8





user.Auth


Aвторизация пользователя.

Параметры


Название параметра

Обязательный параметр

Описание

name

да

Имя пользователя.

password

да

Пароль пользователя.

Результат


В случае успеха возвращается токен для сессии.

Пример ответа в формате XML






533bacf01e11f55b536a565b57531ac114461ae8736d6506a3




Пример ответа в формате JSON


{
   "token":"533bacf01e11f55b536a565b57531ac114461ae8736d6506a3"

}


Коды ошибок


Код ошибки

Описание

1

Неизвестная ошибка

2

Ошибка на сервере

3

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

4

Формат данных не верный

5

Один из параметров имеет неправильное значение или отсутствует

10

Неверный логин или пароль.


user.ForgetPass


Отправляет email пользователю с инструкцией по восстановлению пароля.

Параметры


Название параметра

Обязательный параметр

Описание

name

да

Имя пользователя.

Результат


В случае успеха возвращается строка OK.

Пример ответа в формате XML






OK


Пример ответа в формате JSON


{
   " response ":”OK”

}


Коды ошибок


Код ошибки

Описание

1

Неизвестная ошибка

2

Ошибка на сервере

3

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

4

Формат данных не верный

5

Один из параметров имеет неправильное значение или отсутствует

11

Пользователя с таким именем не существует.

12

Ошибка при отправки email’a.


Номера телефонов


phone.GetAccountPhoneNumbers - возвращает список номеров телефонов, привязанных к аккаунту.

phone.GetCommonPhoneNumbers - возвращает список номер фелефонов, которые были заблокированы системой автоматически.

phone.SaveAccountPhoneNumbers – сохраняет список номеров телефонок на сервере с привязкой к аккаунту.

phone.GetAccountPhoneNumbers (HTTP GET)


Возвращает список номеров телефонов, привязанных к аккаунту.

Результат


Возвращает информацию о номерах телефонок в виде набора массива объектов, каждый из которых содержит поля:

id – идентификатор номера телефона;

number – номер телефона;

name – название телефона, которое установил ему владелец или оператор связи;

is_allow – флаг, показывает заблокирован ли данный номер (если равен 0) или нет (если равен 1);

Пример ответа в формате XML






2

1

+79211234567

Best Friend

1

2

+79211234568

Coupon Service

0



Пример ответа в формате JSON

{
   "count":2,
   "phones":[
      {
         "id":1,
         "number":"+79211234567",
         "name":"Best Friend",
         "is_allow":1
      },
      {
         "id":2,
         "number":"+79211234568",
         "name":"Coupon Service ",
         "is_allow":0
      }
   ]
}


Коды ошибок


Код ошибки

Описание

1

Неизвестная ошибка

2

Ошибка на сервере

3

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


phone.GetCommonPhoneNumbers (HTTP GET)


Возвращает список номер фелефонов, которые были заблокированы системой автоматически.

Результат


Возвращает информацию о номерах телефонок в виде набора массива объектов, каждый из которых содержит поля:

id – идентификатор номера телефона;

number – номер телефона;

name – название телефона, которое установил ему владелец или оператор связи;

Пример ответа в формате XML






2

1

+79211234567

Coupon Service 1

2

+79211234568

Coupon Service 2


Пример ответа в формате JSON


{
   "count":2,
   "phones":[
      {
         "id":1,
         "number":"+79211234567",
         "name":" Coupon Service 1"
      },
      {
         "id":2,
         "number":"+79211234568",
         "name":"Coupon Service 2 "
      }
   ]
}

Коды ошибок


Код ошибки

Описание

1

Неизвестная ошибка

2

Ошибка на сервере

3

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

phone.SaveAccountPhoneNumbers (HTTP POST)


Сохраняет список номеров телефонок на сервере с привязкой к аккаунту.

Параметры


Название параметра

Обязательный параметр

Описание

phones

да

Список номеров телефонов в формате JSON для сохранения



Пример запроса в формате JSON


{
   "phones":[
      {
         "id":1,
         "number":"+79211234567",
         "name":"Best Friend",
         "is_allow":1
      },
      {
         "id":2,
         "number":"+79211234568",
         "name":"Coupon Service ",
         "is_allow":0
      }
   ]
}


Результат


В случае успеха возвращает строку ОК.

Пример ответа в формате XML






OK


Пример ответа в формате JSON


{
   " response ":”OK”

}


Коды ошибок


Код ошибки

Описание

1

Неизвестная ошибка

2

Ошибка на сервере

3

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

4

Формат данных не верный

5

Один из параметров имеет неправильное значение или отсутствует

Добавить документ в свой блог или на сайт

Похожие:

Параметра iconEquation Chapter 1 Section 1Бифуркации Андронова-Хопфа (двухмерная динамическая система)
Часто исследование состояний равновесия некоторой системы в зависимости от параметра может быть сведено к решению уравнения, причем....

Параметра iconТеорема о непрерывности собственного интеграла зависящего от параметра

Параметра iconИсследование разброса параметра. Гистограммы
...

Параметра iconРегламентированная и нормальная температуры пгф и жф блока t
Обозначение параметра символа одним штрихом соответствует парогазовым состояниям среды, двумя штрихами — жидким средам, например...

Параметра iconРешение задач оптимизации (Подбор параметра, Поиск решения, Сценарии "что если" и другие задачи)
Табличный процессор это прикладная программа, которая предназначена для создания электронных таблиц и автоматизированной обработки...

Параметра iconВиды счетов по отношению к балансу
В плане счетов указываются два параметра, определяющие вид счета по отношению к балансу

Параметра iconПараметра
Если вы уже разрабатывали прием платежей WebMoney через Web Merchant Interface, то для подключения вашего магазина к системе z-payment...

Параметра iconРеферат по экологий на тему: «влияние атмосферных загрязнителей на растительность»
Если изменение условий очень значительны, то растения, обладающие большой чувствительностью к таким изменениям, испытывают стресс...

Параметра iconФормула здоровья от
Наше обучение напоминает по форме лекцию, где в нашем своеобразном зале только вы и я. Это даже не лекция, а задушевный разговор....

Параметра iconЛекция: Проверка закона распределения данных (критерии согласия)
Если распределение F0 полностью задано (а его возможные параметры  известны), то говорят, что гипотеза н простая. Если же имеем...

Вы можете разместить ссылку на наш сайт:
Школьные материалы


При копировании материала укажите ссылку © 2013
контакты
vbibl.ru
Главная страница