Архив

Архивные методы продолжают быть активными. На них можно совершать запросы, но делать это не рекомендуется, так как они не будут обновлятся, и могут быть удалены в любой момент, когда потребность в них исчезнет.

Сюда будут перенесены их описаниях из других областей описания API.

Запрос регистрации агента

Для обращения к  сервису необходимо иметь логин и пароль аккаунта Consenta.ru с доступом к API функциям.

Есть два способа регистрации агента через Get запрос(старое решение) и через Post запрос (новое решение).

1. Запрос регистрации агента через Get запрос представляет собой обращение по HTTPS-протоколу к URL  https: //consenta.ru/RegionalAPI/registerAgent с параметрами для регистрации. 

Например, для того, чтобы зарегистировать агента под регионалом c идентификатором регионала id=171, именем агента  userName  =  Test, электронной почтой  email  =  test@test.com, регионом с идентификатором региона  regionId  =223, и имея логин login=test@mail.ru и пароль password=12345 от аккаунта Consenta.ru с доступом к API функциям,   можно выполнить следующий запрос:  https: //consenta.ru/RegionalAPI/registerAgent?login=test@mail.ru&password=12345&id=171&userName=Test&email=test@test.com&regionId=223&acceptTerms=true.

В конце запроса передаётся параметр  acceptTerms, значение которого является признаком согласен новый агент с условиями соглашения или нет (  true  или  false  соответственно).

Ниже в таблице приведен список параметров HTTPS -запроса регистрации агента:

Примечание: если в передаваемых параметрах встречаются зарезервированные символы URL,
то их необходимо закодировать.

Зарезервированные символы кодируются в таком соответствии:

2. Запрос регистрации агента через Post запрос представляет собой обращение по HTTPS-протоколу к URL  https: //consenta.ru/RegionalAPI/registerAgentPost с параметрами для регистрации. 

Например, для того, чтобы зарегистировать агента под регионалом c  логином login=test@mail.ru и паролем password=12345 от аккаунта Consenta.ru с доступом к API функциям, с  именем агента  userName  =  Test, электронной почтой  email  =  test@test.com, регионом с идентификатором региона  regionId  =223, можно выполнить следующий запрос:$.post(" https: //consenta.ru/RegionalAPI/registerAgentPost", { login: "test@mail.ru", password: "12345", userName: "test", email: "test@test.com", regionId: 223, acceptTerms: "true"} );

В конце запроса передаётся параметр  acceptTerms, значение которого является признаком согласен новый агент с условиями соглашения или нет (  true  или  false  соответственно).

Ниже в таблице приведен список параметров HTTPS -запроса регистрации агента:

Ответ на запрос регистрации агента в формате XML

Ответ возвращается в формате XML. Рассмотрим XML-ответ сервиса на запрос  https://consenta.ru/RegionalAPI/registerAgent?login=test@mail.ru&password=12345&id=171&userName=Test&email=test@test.com&regionId=223&acceptTerms=true .

 Во время этого запроса произойдёт попытка создания нового агента. В результате с ервис вернёт ответ в виде XML-документа с идентификатором нового агента при удачной регистрации или текст ошибки при неудачной регистрации.

Примерный ответ при удачной регистрации:

<consenta_registerAgent date="2015-04-14 15:27">

<registerAgent Result="успешно" Value="2085"/>

</consenta_registerAgent>

Примерный ответ при неудачной регистрации:

1.

<consenta_registerAgent date="2015-04-14 15:28">

2.

<consenta_registerAgent date="2015-04-14 15:28">

<registerAgent Result="неудачно" Value="Во время регистрации произошла ошибка: Введенный вами email уже присутствует, попробуйте другой."/>

</consenta_registerAgent>

Аттрибут date элеимента consenta_registerAgent содержит дату и время ответа. Элемент registerAgent  имеет два аттрибута:

·         аттрибут Result содержит информацию об успешности операции регистрации нового агента;

·         аттрибут Value содержит идентификатор нового агента при удачной регистрации или текст ошибки при неудачной регистрации.