Как использовать API ShareFile для создания "пользователя клиента"?

Question

Используя API ShareFile, я хотел бы создать "пользователя клиента", но существующая документация недостаточно детальна, чтобы выполнить задачу прямо.

Пожалуйста, предоставьте пример HTTP-запроса и ответа, который демонстрирует использование конечной точки "Создать пользователя клиента".

Answer 1

Перед отправкой запроса вам необходимо убедиться, что соответствующая учетная запись настроена и вы получили токен oauth2. Если вы войдете в систему с учетной записью ShareFile и посетите документацию, токен oauth2, который вы можете использовать, будет отображаться в верхней части страницы.

Оттуда вам нужно построить свой запрос. Вот пример запроса с некоторыми деталями, отредактированными звездочками для защиты невинных:

POST /sf/v3/Users HTTP/1.1
Host: **********.sf-api.com
Authorization: Bearer **********
Content-Type: application/json
Cache-Control: no-cache

{"Preferences": {"CanResetPassword": true, "CanViewMySettings": true}, "FirstName": "Billy", "LastName": "Bobby", "Company": "Bobby's World", "Password": "**********", "Email": "**********", "DefaultZone": {"Id": "**********"}}

А вот пример тела ответа:

{
 "Email": "************", 
 "Username": "************", 
 "TotalSharedFiles": 0, 
 "Id": "************", 
 "Contacted": 0, 
 "FirstName": "Billy", 
 "ReferredBy": "************", 
 "IsConfirmed": false, 
 "LastName": "Bobby", 
 "Company": "Bobby's World", 
 "FullNameShort": "B. Bobby", 
 "DateCreated": "2017-02-13T22:19:07.92Z", 
 "odata.metadata": "https://************.sf-api.com/sf/v3/$metadata#Users/ShareFile.Api.Models.User@Element", 
 "url": "https://************.sf-api.com/sf/v3/Users(************)", 
 "Domain": "************", 
 "FullName": "Billy Bobby", 
 "odata.type": "ShareFile.Api.Models.User", 
 "Roles": 
     ["Client", "CanChangePassword", "CanManageMySettings"], 
 "Emails": ["************"]
}

Наряду с телом ответа будет несколько заголовков, которые могут быть полезны в зависимости от вашей ситуации. В частности, обратите внимание на заголовки Set-Cookie SFAPI_AuthID и SFAPI_SRVNAME. Согласно документации, эти значения могут быть сохранены вашим клиентом и использованы для облегчения загрузки серверов API ShareFile для последующих вызовов API.