Имя: AgentRegister
Метод: HTTPS POST
Описание: Регистрирует нового агента в программе в случае успеха или сообщает об ошибке.
Формат: JSON
Параметры:
| Именование параметра | Значение параметра | Пример значения | Связанные коды ошибок |
|---|---|---|---|
| login | Логин регионала | login=myLogin@login.ru |
|
| password | Пароль регионала | password=qwerty12345 |
|
| agentName | Имя нового агента | agentName=agentTest |
|
| agentEmail | Email нового агента | agentEmail=test@test.io |
|
| agentPhone | Телефон нового агента | agentPhone=79999999999 или пустое |
|
| agentRegion | Идентификатор региона для нового агента | agentRegion=101 |
|
Если регистрация прошла успешно, то будет получен JSON-ответ с кодом "Success". Таким образом, формат ответа выглядит следующим образом: { success = true/false, code = "Один из кодов, указанных выше", message = "Поясняющее сообщение" }.
Пример запроса:
https://consenta.ru/RegionalAPI/AgentRegister? login=myLogin@login.ru&password=qwerty12345&agentName=agentTest&agentEmail=test@test.io&agentPhone=79999999999&agentRegion=101
Примечание: если в передаваемых параметрах встречаются зарезервированные символы URL, то их необходимо закодировать.
Зарезервированные символы кодируются в таком соответствии:
| ! | " | # | % | & | ' | * | + | , | : | ; | < | = | > | ? | [ | ] | ^ | ` | { | | | } | < пробел> |
| %21 | %22 | %23 | %25 | %26 | %27 | %2a | %2b | %2c | %3a | %3b | %3c | %3d | %3e | %3f | %5b | % |