Content Comparison

...

Адрес: https://api.cloudtips.ru/api/receivers/create-many

Тип: POST

Запрос:

Пример запроса:

{
  "placeId": "string",
  "needConfirmLayouts" : true
  "receivers": [
    {
      "phoneNumber": "string",
      "name": "string",
      "sendPasswordexternalId": "string",
"bool"      "sendPassword": true
    }
  ]
}

Ответ:

Пример ответа:

{
  "data": {
    "created": [
      {
        "phoneNumber": "string",
        "name": "string",
        "userId": "string",
        "layoutId": "string",
        "layoutStatus": 0
      }
    ],
    "skipped": [
      {
        "phoneNumber": "string",
        "name": "string",
        "userId": "string",
        "layoutId": "string",
        "layoutStatus": 0
      }
    ]
  },
  "succeed": true,
  "errorCode": 0,
  "errors": [
    "string"
  ],
  "validationErrors": {
    "additionalProp1": [
      "string"
    ],
    "additionalProp2": [
      "string"
    ],
    "additionalProp3": [
      "string"
    ]
  }
}

Если получатель не был в системе, то он вернется в массиве created и layoutStatus = NoneWaitingForConfirmation. Никаких подтверждений со стороны пользователя не требуется.

Если получатель уже есть в системе и не в вашем скоупе, то он вернется в массиве created и layoutStatus = WaitingForConfirmation, то необходимо подтверждение привязки от пользователя. Для этого надо получателями не планируется использование личного кабинета CloudTips, то для дальнейшей работы необходимо воспользоваться методом Привязка получателя к заведению.

Если получатель уже есть в системе и в вашем скоупе, то вернется ошибка: “Некоторые номера уже в скоупе: “{номер сотрудника}””

Привязка получателя к заведению

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

POST /places/{placeId}/employees/attach/send-sms

{
  UserId: string
}

UserId берется из блока created метода Создание получателя

Интервал между отправками смс - 1 минута

После в вашем интерфейсе запросить от сотрудника передать вам код из смс.

POST /places/{placeId}/employees/attach/confirm

{
  UserId: string,
  SmsCode: string
}

Загрузки фотографии получателя

...

Возможные ошибки

{
  "succeed": false,
  "errors": [],
  "validationErrors": {
    "PhoneNumber": [
      "Неверный формат телефонного номера: {тут присланный номер телефона}"
    ]
  }
}

{
  "succeed": false,
  "errors": [],
  "validationErrors": {
    "PlaceId": [
      "Необходимо указать заведение"
    ]
  }
}

{
  "succeed": false,
  "errors": [],
  "validationErrors": {
    "Receivers": [
      "Необходимо указать получателей"
    ]
  }
}

{
  "succeed": false,
  "errors": [Заведение {идентификатор заведения} не найдено],
  "validationErrors": {
  }
}

{
  "succeed": false,
  "errors": [],
  "validationErrors": {
    "PhoneNumber": [
      "Некоторые из указанных номеров уже в скоупе: {номера телефонов через запятую}"
    ]
  }
}

Привязка получателя к заведению

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

POST /places/{placeId}/employees/attach/send-sms

{
  UserId: string
}

UserId берется из блока created метода Создание получателя

Интервал между отправками смс - 1 минута

После в вашем интерфейсе запросить от сотрудника передать вам код из смс.

POST /places/{placeId}/employees/attach/confirm

{
  UserId: string,
  SmsCode: string
}

Загрузки фотографии получателя

Описание: Позволяет загрузить аватарку получателю

Адрес: https://api.cloudtips.ru/api/receivers/{userId}/photo, где userId уникальный идентификатор получателя в системе

Тип: POST, хедер Content-Type=multipart/form-data;
Запрос:

Пример запроса:

-

Ответ:

Пример ответа:

{
  "data": {
     "photoUrl": "string",
     "photold": "string"
  },
  "succeed": true,
  "errors": [
    "string"
  ],
  "validationErrors": {
    "additionalProp1": [
      "string"
    ]
  }
}

Удаление фотографии получателя

Описание: Позволяет удалить аватарку получателю

Адрес: https://api.cloudtips.ru/api/receivers/{userId}/photo, где userId уникальный идентификатор получателя в системе

Тип: DELETE
Запрос:

-

Пример запроса:

-

Ответ:

Пример ответа:

{
  "succeed": true,
  "errors": [
    "string"
  ],
  "validationErrors": {
    "additionalProp1": [
      "string"
    ]
  }
}

Редактирование данных получателя

Описание: Позволяет отредактировать данные получателя. Можно передавать одно значение из списка, а не весь список.

Адрес: https://api.cloudtips.ru/api/receivers/{userId}/photo, где userId уникальный идентификатор получателя в системе

Тип: POST, хедер Content-Type=multipart/form-data;
Запрос:

...

Тип

...

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

...

Описание

...

FormFile

...

file

...

Да

...

Файл с фотографией

Пример запроса:

-

Ответ: PATCH

Запрос:

...

Пример запроса:

{
[
 "data": {
     "photoUrlop": "stringreplace",
     "photoldpath": "string/Name"
,
 },   "succeedvalue": true,
  "errorsstring":
[  },
  "string"{
  ],   "validationErrorsop": {"replace",
    "additionalProp1path": ["/Email",
    "value":  "string"
 
  ]
  }
}

Удаление фотографии получателя

Описание: Позволяет удалить аватарку получателю

Адрес: https://api.cloudtips.ru/api/receivers/{userId}/photo, где userId уникальный идентификатор получателя в системе

Тип: DELETE
Запрос:

-

Пример запроса:

-

  }
]

Ответ:

Пример ответа:

{
  "succeed": true,
  "errors": [
    "string"
  ],
  "validationErrors": {
    "additionalProp1": [
      "succeed": truestring"
    ],
    "errorsadditionalProp2": [
      "string"
    ],
  "validationErrors": {     "additionalProp1additionalProp3": [
      "string"
    ]
  }
}

Редактирование данных

...

платежной страницы

Описание: Позволяет отредактировать данные получателя. Можно передавать одно значение из списка, а не весь список.о платежной страницы.

Адрес: https://api.cloudtips.ru/api/receivers​paymentpages/{userIdlayoutId}, где userId уникальный layoutId идентификатор платежной страницы получателя в системе

Тип: PATCH

Запрос:

Пример запроса:

[
  {
    "op": "replace",
    "path": "/Name",
    "value":  "string"
  },
  {
    "op": "replace",
    "path": "/EmailWorkInfo/ChannelUrl",
    "value":  "string"
  }
]

Ответ:

Пример ответа:

{
  "succeed": true,
  "errors": [
    "string"
  ],
  "validationErrors": {
    "additionalProp1": [
      "string"
    ],
    "additionalProp2": [
      "string"
    ],
    "additionalProp3": [
      "string"
    ]
  }
}

...

Тип: GET

Запрос:

Пример запроса:

{
  "dateFrom": "string",
  "dateTo": "string",
  "phoneNumber": "string",
  "name": "string",
  "layoutId": "string",
  "placeId": "string",
  "type": "",
  "userId": [
      "string"
    ],
  "page": "integer",
  "limit": "integer"
}

Ответ:

Пример ответа:

{  
  {
    "items": [
      {
        "userId": "string",
        "phoneNumber": "string",
        "email": "string",
        "fullName": "string",
        "type": 0,
        "layouts": [
          {
            "id": "string",
            "shortId": "string",
            "default": true,
            "disabled": true,
            "title": "string",
            "description": "string",
            "text": "string",
            "backgroundId": "string",
            "placeId": ""string",
            "placeName": "string",
            "userId": "string"
            "externalInfo": "string"
          }
        ],
        "manager": {
          "managerId": "string",
          "name": "string",
          "externalId": "string",
          "email": "string"
        },
        "photoId": "string",
        "photoUrl": "string",
        "cardFirstSix": "string",
        "cardLastFour": "string",
        "cardExpDate": "string",
        "payoutMethod": 0,
        "lockoutEnd": "2021-05-27T12:37:53.822Z",
        "phoneNumberConfirmed": true,
        "createdDate": "2021-05-27T12:37:53.822Z",
        "updatedDate": "2021-05-27T12:37:53.822Z"
      }
    ],
    "totalCount": 0
  },
  "succeed": true,
    "errors": [
      "string"
    ],
    "validationErrors": {
      "additionalProp1": [
        "string"
      ],
      "additionalProp2": [
        "string"
      ],
      "additionalProp3": [
        "string"
      ]
}

...

Адрес: https://api.cloudtips.ru/api/receivers/{userId}/payout-method, где userId - уникальный идентификатор получателя

Тип: POST

Запрос:

Пример запроса:

{
  "payoutMethod": 0
}

Ответ:

Пример ответа:

{
  "succeed": true,
  "errors": [
    "string"
  ],
  "validationErrors": {
    "additionalProp1": [
      "string"
    ],
    "additionalProp2": [
      "string"
    ],
    "additionalProp3": [
      "string"
    ]
  }
}

...

Адрес: https://api.cloudtips.ru/api/receivers/{userId}/detach-agent, где userId уникальный идентификатор получателя

Тип: POST

Запрос:

Пример запроса:

-

Ответ:

Пример ответа:

{
  "succeed": true,
  "statusCode": 0,
  "errors": [
    "string"
  ],
  "validationErrors": {
    "additionalProp1": [
      "string"
    ],
    "additionalProp2": [
      "string"
    ],
    "additionalProp3": [
      "string"
    ]
  }
}

...