Регистрация

Запросы отправлять сюда: https://apicxhub.mail.ru/

Нельзя помещать вложенные переменные в свои массивы. То есть, значения Consent не записать в ExtraParameters и наоборот.

Регистрация с паролем

Схема интеграции с паролем

POST /Registration

{ 
    "ApplicationId": 123321, // обязательное, айди приложения в интерфейсе 
    "Secret": "123321", // обязательное - секрет из приложения
    "SourceId": "Test_SourceId", // обязательное, источник данных 
    "UserData": { 
        "Firstname": "Имя",  // опционально 
        "Surname": "Фамилия", // опционально 
        "Middlename": "Отчество", // опционально 
        "Phone": "79777221374", // обязательно * Переводим +7 и 8 вначале телефона в 7 для 11 цифр 
        "Email": "[email protected]", // обязательно * 
        "Password": "TestPassword", // обязательно 
        "BirthDate": "2020.12.12", // опционально 
        "City": "г.Москва, Ул Первая, д 2", // опционально 
        "PersonalDataAgree": true, // опционально 
        "ExtraParameters": [  // опционально - набор параметров специфичный для источника 
            { 
                "Name": "ClientType", 
                "Value": " Breeder" // Breeder, Veterinar или User 
            }, 
            { 
                "Name": "Название магазина", 
                "Value": "Магазин Гранат" 
            }, 
            { 
                "Name": "Адрес магазина", 
                "Value": "Ул Мира д1" 
            }, 
            { 
                "Name": "Серия и номер", 
                "Value": "0011 223344" 
            }, 
            { 
                "Name": "Кем выдан", 
                "Value": "Отделом УФМС по Московской области в гор. Подольске" 
            }, 
            { 
                "Name": "Когда выдан", 
                "Value": "19.12.2019" 
            }, 
            { 
                "Name": "Данные регистрации по паспорту", 
                "Value": "г. Москва Ул. Зеленая д 1 кв 1" 
            }, 
            { 
                "Name": "Номер ИНН", 
                "Value": "123456789" 
            } 
        ], 
        "Consent": [  // набор специфичных соглашений для источника - опционально 
            { 
                "Consent": "TestSourceIdEmail", 
                "Value": true 
            } 
        ] 
    } 
} 

Регистрация без пароля

Схема интеграции без пароля и авторизации

POST /Registration

{ 
    "ApplicationId": 123321, // обязательное, айди приложения в интерфейсе 
    "Secret": "123321", // обязательное - секрет из приложения 
    "SourceId": "Test_SourceId", // обязательное, источник данных 
    "Type":"Simple", 
    "UserData": { 
        "Firstname": "Имя",  // опционально 
        "Surname": "Фамилия", //  опционально 
        "Middlename": "Отчество", // опционально 
        "Phone": "79777221374", // обязательно * Переводим +7 и 8 вначале телефона в 7 для 11 цифр 
        "Email": "[email protected]", // обязательно * 
        "BirthDate": "2020.12.12", // опционально 
        "City": "г.Москва, Ул Первая, д 2", // опционально 
        "PersonalDataAgree": true, // опционально 
        "ExtraParameters": [  // опционально - набор параметров специфичный для источника 
            { 
                "Name": "ClientType", 
                "Value": " Breeder" // Breeder, Veterinar или User 
            }, 
            { 
                "Name": "Название магазина", 
                "Value": "Магазин Гранат" 
            }, 
            { 
                "Name": "Адрес магазина", 
                "Value": "Ул Мира д1" 
            }, 
            { 
                "Name": "Серия и номер", 
                "Value": "0011 223344" 
            }, 
            { 
                "Name": "Кем выдан", 
                "Value": "Отделом УФМС по Московской области в гор. Подольске" 
            }, 
            { 
                "Name": "Когда выдан", 
                "Value": "19.12.2019" 
            }, 
            { 
                "Name": "Данные регистрации по паспорту", 
                "Value": "г. Москва Ул. Зеленая д 1 кв 1" 
            }, 
            { 
                "Name": "Номер ИНН", 
                "Value": "123456789" 
            } 
        ], 
        "Consent": [  // набор специфичных соглашений для источника 
            { 
                "Consent": "TestSourceIdEmail", 
                "Value": true 
            } 
        ] 
    } 
} 

По инвайту

Используется, когда нужно прикрепить к пользователю-"родителю" пользователей-"детей". По "родителю" можно находить "детей" и наоборот.

Например: Учитель и ученики. Директор клиники и сотрудники.

1. Получить инвайт "родителя"

POST /GetInviteCode

{  
    "ApplicationId": 123321, 
    "Secret": "123321", 
    "SourceId": "Test_SourceId", 
    "UserData": { 
        "UserId": "Test_UserId",  
        "SecretKey": "Test_SecretKey" 
    } 
} 

Ответ:

{ 
    "UserData":{ 
        "UserId":"Test_74fcb1212a9-4483-11eb-86e0-ace2d35288a0", 
        "SecretKey":"Test_Kn71212lJZ4Wk0tVQ0cDRCFZNf" 
        } 
    "Invite":{ 
        "Code": "XXXXXX" 
    } 
} 

2. Зарегистрировать по инвайту

POST /Registration

{ 
    "ApplicationId": 123321, // обязательное, айди приложения в интерфейсе 
    "Secret": "123321", // обязательное - секрет из приложения 
    "SourceId": "Test_SourceId", // обязательное, источник данных 
    "Type":"Invite", 
    "UserData": { 
        "ExtraLogin": "id",                 // какое-то уникальное имя логина ник - использовать только буквы латинского алфавита ".","-","_", цифры 
        "Password": "Phahah", // обязательно 
        "Firstname": "Имя",                 // опционально 
        "Surname": "Фамилия",               // опционально 
        "Middlename": "Отчество",           // опционально 
        "BirthDate": "2020.12.12",          // опционально 
        "City": "г.Москва, Ул Первая, д 2", // опционально 
        "PersonalDataAgree": true,          // опционально 
        "ExtraParameters": [                // опционально - набор параметров специфичный для источника 
            { 
                "Name": "ClientType", 
                "Value": " Breeder" // Breeder, Veterinar или User  
            }, 
            { 
                "Name": "Название магазина", 
                "Value": "Магазин Гранат" 
            }, 
            { 
                "Name": "Адрес магазина", 
                "Value": "Ул Мира д1" 
            }, 
            { 
                "Name": "Серия и номер", 
                "Value": "0011 223344" 
            }, 
            { 
                "Name": "Кем выдан", 
                "Value": "Отделом УФМС по Московской области в гор. Подольске" 
            }, 
            { 
                "Name": "Когда выдан", 
                "Value": "19.12.2019" 
            }, 
            { 
                "Name": "Данные регистрации по паспорту", 
                "Value": "г. Москва Ул. Зеленая д 1 кв 1" 
            }, 
            { 
                "Name": "Номер ИНН", 
                "Value": "123456789" 
            } 
        ], 
        "Consent": [  // опционально - набор специфичных соглашений для источника 
            { 
                "Consent": "TestSourceIdEmail", 
                "Value": true 
            } 
        ] 
    }, 
    "Invite": { 
    "Code" : "SGHSGH" // обязательное поле 
    } 
} 

Ответ для всех

В случае успеха возвращает 200 ОК и сессию юзера

В случае успешной регистрации на email и phone нужно отправить код подтверждения. Cообщения о подтверждении емейла и телефона требуется настроить в интерфейсе.

{ 
    "UserData":{ 
        "UserId":"Test_74fcb1212a9-4483-11eb-86e0-ace2d35288a0", 
        "SecretKey":"Test_Kn71212lJZ4Wk0tVQ0cDRCFZNf" 
     } 
} 

В случае ошибки возвращаются статусы 4xx (см. раздел ошибок)