MyChat Integration API: MCIAPI_CS_RegisterNewUser регистрация нового пользователя
Зареєструвати на сервері нового користувача.
Синтаксис
{
"cmd" : "0010",
"ServerKey" : "iddqd",
"APIStype" : "php",
"context" : "myfunc",
"Nick" : "JohnSnow",
"AuthType" : 1,
"Password" : "mysecretword",
"Email" : "[email protected]",
"Domain" : "circle1.fbi.com",
"FirstName" : "John",
"LastName" : "Snow",
"Sex" : 1
}
Параметри
|
Параметр |
Тип |
Значення |
|
cmd |
string |
"0010", номер команди MCIAPI_CS_RegisterNewUser; |
|
ServerKey |
string |
ключ Integration API, задається у налаштуваннях сервера; |
|
APIStype |
string |
тип інтеграції. Можна задавати довільний рядок; |
|
context |
string |
необов'язковий параметр, будь-який текст, що повернеться у команді-відповіді; |
|
Nick |
string |
нік користувача, обов'язкове унікальне поле; |
|
Password |
string |
пароль користувача. Може бути пустим, якщо використовується безпарольна автентифікація; |
|
|
string |
адреса електронної пошти користувача. Необов'язковий параметр; |
|
Domain |
string |
ім'я домену користувача. Необов'язковий параметр; |
|
FirstName |
string |
ім'я користувача. Необов'язковий параметр; |
|
LastName |
string |
прізвище користувача. Необов'язковий параметр; |
|
MiddleName |
string |
по-батькові користувача. Необов'язковий параметр; |
|
Sex |
integer |
стать користувача. Необов'язковий параметр. Усталено задається "невідомо"; |
|
AuthType |
integer |
тип автентифікації користувача, цифра. |
Результат роботи
{
"cmd" : "0010",
"context" : "myfunc",
"UIN" : 39,
"Nick" : "JohnSnow"
}
|
Поле |
Тип |
Значення |
|
cmd |
integer |
номер команди, що була успішно виконана, рівно 16 (HEX 0010); |
|
context |
string |
довільний текст, що був переданий серверу в команді запиту; |
|
UIN |
integer |
унікальний ідентифікатор створеного користувача (UIN). |
|
Nick |
string |
нік користувача. |
Приклад використання мовою PHP
<?php
$postData = (array // заповнення полів для запиту
(
'cmd' => '0010',
'Nick' => 'JohnSnow',
'Password' => 'mysecretword',
'Email' => '[email protected]',
'Domain' => 'circle1.winterfell.com',
'FirstName' => 'John',
'LastName' => 'Snow',
'MiddleName'=> 'S.',
'Sex' => 1,
'IP' => '192.168.10.133',
'NetName' => 'throne1',
'ClientType'=> 'web',
'AuthType' => 0,
'APIStype' => 'php',
'ServerKey' => 'iddqd'
)
);
$myCurl = curl_init();
curl_setopt_array($myCurl, array(
CURLOPT_URL => 'https://192.168.10.133/API/', // вказуємо шлях входу
CURLOPT_RETURNTRANSFER => true, // повернення результату передачі в якості рядка
CURLOPT_SSL_VERIFYHOST => false, // відключення перевірки SSL
CURLOPT_SSL_VERIFYPEER => false, // відключення перевірки SSL
CURLOPT_POST => true, // увімкнення POST режиму
CURLOPT_HEADER => true, // увімкнення заголовків
CURLOPT_HTTPHEADER => array('integrationapi: mychat'), // додавання !обов'язкового! заголовку — integrationapi: mychat
CURLOPT_POSTFIELDS => json_encode($postData) // перелік даних запиту у форматі JSON
));
$response = curl_exec($myCurl); // відправка запиту
if($response === FALSE){ // перевірка помилок
die(curl_error($myCurl));
}
curl_close($myCurl); // закриття з'єднання
echo $response; // виведення відповіді
?>
Можливі помилки
#5, MCIAPI_Error_WrongIntegrationKey
#10, MCIAPI_Error_ParameterAbsent
#14, MCIAPI_Error_NickAlreadyExists
#18, MCIAPI_Error_NickCannotBeEmpty
#44, MCIAPI_Error_ReservedNickName
#45, MCIAPI_Error_PasswordCannotBeEmpty
#46, MCIAPI_Error_DomainNickAlreadyExists
#47, MCIAPI_Error_ParameterIsEmpty