четверг, 24 ноября 2022 г.

doRegister — описание SOAP и REST-метода в Users

Ссылка на конфлюенс. Там красивее смотрится верстка, но просмотр только после авторизации. Вот логин-пароль, но на всякий случай продублирую в блоге.

Это общедоступный API-метод, который вы можете подергать для ознакомления.


Ссылка на метод

REST — http://users.bugred.ru/tasks/rest/doregister (POST-запрос)


Описание метода

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


Входные параметры

Имя параметра
Тип
Обязательный?
Описание
emailстрокадаemail пользователя
nameстрокадаимя пользователя
passwordстрокадапароль

Результирующие данные

Имя параметра
Описание
partyИнформация по сохраненному клиенту


Особенности использования

Пользователь создается и появляется в системе. Автор у него всегда будет «SOAP / REST», изменять его можно только через соответствующий-метод.

Имя и емейл должны быть уникальными.


Примеры вызова SOAP

Пример 1. Создание нового пользователя

Запрос:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wrap="http://foo.bar/wrappersoapserver">

   <soapenv:Header/>

   <soapenv:Body>

      <wrap:doRegister>

         <email>qq26@gmail.com</email>

         <name>qq555</name>

         <password>1</password>

      </wrap:doRegister>

   </soapenv:Body>

</soapenv:Envelope> 

Ответ:

<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://users.bugred.ru/tasks/soap/WrapperSoapServer.php" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">

   <SOAP-ENV:Body>

      <ns1:doRegisterResponse>

         <return xsi:type="SOAP-ENC:Struct">

            <email xsi:type="xsd:string">qq26@gmail.com</email>

            <name xsi:type="xsd:string">qq555</name>

            <avatar xsi:type="xsd:string">http://users.bugred.ru//tmp/default_avatar.jpg</avatar>

            <password xsi:type="xsd:string">4dff4ea340f0a823f15d3f4f01ab62eae0e5da579ccb851f8db9dfe84c58b2b37b89903a740e1ee172da793a6e79d560e5f7f9bd058a12a280433ed6fa46510a</password>

            <birthday xsi:type="xsd:int">0</birthday>

            <gender xsi:type="xsd:string"/>

            <date_start xsi:type="xsd:int">0</date_start>

            <hobby xsi:type="xsd:string"/>

            <name1 xsi:type="xsd:string"/>

            <surname1 xsi:type="xsd:string"/>

            <fathername1 xsi:type="xsd:string"/>

            <cat xsi:type="xsd:string"/>

            <dog xsi:type="xsd:string"/>

            <parrot xsi:type="xsd:string"/>

            <cavy xsi:type="xsd:string"/>

            <hamster xsi:type="xsd:string"/>

            <squirrel xsi:type="xsd:string"/>

            <phone xsi:type="xsd:string"/>

            <adres xsi:type="xsd:string"/>

         </return>

      </ns1:doRegisterResponse>

   </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


Пример 2. Такой пользователь уже существует

Запрос:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wrap="http://foo.bar/wrappersoapserver">

   <soapenv:Header/>

   <soapenv:Body>

      <wrap:doRegister>

         <email>qq26@gmail.com</email>

         <name>qq555</name>

         <password>1</password>

      </wrap:doRegister>

   </soapenv:Body>

</soapenv:Envelope> 


Ответ:

<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://users.bugred.ru/tasks/soap/WrapperSoapServer.php" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">

   <SOAP-ENV:Body>

      <ns1:doRegisterResponse>

         <return xsi:type="SOAP-ENC:Struct">

            <type xsi:type="xsd:string">error</type>

            <code xsi:type="xsd:int">0</code>

            <message xsi:type="xsd:string">email qq26@gmail.com уже есть в базе</message>

         </return>

      </ns1:doRegisterResponse>

   </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


Примеры вызова REST (JSON)

Пример 1. Создание нового пользователя

Запрос:

{

    "email": "milli@mail.ru",

    "name": " Машенька",

    "password": "1"

}


Ответ:

{

    "name": " Машенька",

    "avatar": "http://users.bugred.ru//tmp/default_avatar.jpg",

    "password": "4dff4ea340f0a823f15d3f4f01ab62eae0e5da579ccb851f8db9dfe84c58b2b37b89903a740e1ee172da793a6e79d560e5f7f9bd058a12a280433ed6fa46510a",

    "birthday": 0,

    "email": "milli@mail.ru",

    "gender": "",

    "date_start": 0,

    "hobby": ""

}



Все методы сделаны для моего курса «Тестирование REST API». Теорию я выкладываю на youtube и в блог, а за практикой заходите!

Комментариев нет:

Отправить комментарий