Документация по API Центра приложений

Спецификация OpenAPI в Центре приложений (Swagger)

Центр приложений предоставляет полный набор конечных точек API. Вы можете изучить API Центра приложений с помощью спецификации OpenAPI в Центре приложений.

Спецификация OpenAPI в Центре приложений позволяет выполнять проверку подлинности с помощью маркера API. После проверки подлинности можно вызвать API Центра приложений, чтобы узнать об API и узнать, какие данные возвращаются.

Типы маркеров: маркеры пользователей и маркеры приложения

Центр приложений предоставляет два типа маркеров API: маркеры пользователей и маркеры приложения.

Пользовательские токены API имеют те же права, что и вы, как пользователь Центра приложений. Пользовательские токены API работают во всех организациях и приложениях, с которыми вы ассоциированы.

Маркеры API приложений имеют права менеджера или просмотра, но только в одном приложении.

Каждая учетная запись Центра приложений может создавать до 5000 маркеров API.

Создание маркера API приложения Центра приложений

1. Перейдите к https://appcenter.ms и войдите, используя ваши учетные данные.

2. Выберите приложение , для которого нужно создать маркер API.

3. В левой части нажмите кнопку "Параметры".

4. На средней панели выберите маркеры API приложений в списке меню.

5. В правом верхнем углу щелкните новый маркер API.

6. В текстовом поле введите описательное название для вашего токена.

7. Выберите тип доступа для маркера API приложений:

   Полный доступ: Маркер API приложений полного доступа имеет эквивалент разрешений Диспетчера для этого приложения. Только руководители могут создавать маркеры API приложений полного доступа.

   Только для чтения: Маркер API приложения только для чтения имеет эквивалент разрешений на доступ к средству просмотра для этого приложения. Руководители и разработчики могут создавать токены API приложения с правами только для чтения.

8. В нижней части панели нажмите кнопку "Добавить новый маркер API".

9. Всплывающее окно откроется с вашим токеном API приложения. Скопируйте и сохраните его в безопасном расположении для последующего использования. По соображениям безопасности после нажатия кнопки "Закрыть " вы не можете увидеть или создать один и тот же маркер еще раз.

10. Нажмите кнопку Закрыть .

Создание токена API пользователя Центра приложений

1. Перейдите к https://appcenter.ms и войдите, используя ваши учетные данные.

2. В правом верхнем углу портала Центра приложений щелкните аватар учетной записи и выберите параметры учетной записи.

3. На средней панели выберите маркеры API пользователей из списка меню.

4. В правом верхнем углу щелкните новый маркер API.

5. В текстовом поле введите описательное название для вашего токена.

6. Выберите тип доступа для токена API пользователя.

   Полный доступ: Маркер API пользователя с полным доступом имеет все разрешения, которые у вас есть для текущей учетной записи или организации. Например, если у вас нет разрешений диспетчера или разработчика для приложения, пользователь не может выполнить тест, даже если вы используете маркер API пользователя полного доступа.

   Только для чтения: Токен API с правами только для чтения имеет права просмотра для текущей учетной записи и организации. Например, с токеном API пользователя, разрешающим только чтение, можно считывать данные о сбоях, аналитике и получать базовую информацию о приложении. Токены API с доступом только для чтения не могут изменять настройки приложения, создавать конфигурацию экспорта и т. д.

7. В нижней части панели нажмите кнопку "Добавить новый маркер API".

8. Всплывающее окно откроется с вашим токеном API пользователя. Скопируйте и сохраните его в безопасном расположении для последующего использования. По соображениям безопасности после нажатия кнопки "Закрыть " вы не можете увидеть или создать один и тот же маркер еще раз.

9. Нажмите кнопку Закрыть .

Использование маркера API в запросе API

При отправке запросов API в Центр приложений необходимо включить маркер API в заголовок каждого запроса, отправляемого в Центр приложений.

Передайте маркер API в свойстве заголовка X-API-Token запроса.

Найдите имя вашего приложения в Центре приложений и имя владельца.

Для некоторых функций API Центра приложений и запросов CLI требуется имя приложения или имя владельца в качестве параметров.

Например, вызов API для удаления пользователя из приложения требует наличия обоих элементов: DELETE /v0.1/apps/{owner_name}/{app_name}/users/{user_email}.

Имя приложения и имя владельца можно найти по URL-адресу Центра приложений или с помощью интерфейса командной строки Центра приложений.

Найдите owner_name и app_name в URL-адресе Центра приложений

1. Перейдите по адресу https://appcenter.ms.
2. Перейдите к приложению.
3. При просмотре URL-адреса приложения он находится в формате https://appcenter.ms/users/{owner-name}/apps/{app-name}.

Владелец может быть пользователем или организацией. Рассмотрим пример.

Найдите owner_name и app_name в интерфейсе командной строки Центра приложений

Если вы еще не установили интерфейс командной строки Центра приложений, инструкции по установке и использованию можно найти в документации по CLI Центра приложений.

После установки получите список приложений, к которым у вас есть доступ, выполнив следующую команду:

appcenter apps list

Интерфейс командной строки Центра приложений будет отображать список приложений с форматом {owner-name}/{app-name}.

Ознакомьтесь с документацией по CLI Центра приложений для полного списка функций командной строки.

Использование токена API в спецификации OpenAPI Центра приложений

Спецификация OpenAPI в Центре приложений обрабатывает проверку подлинности API для вас, поэтому вам не нужно вставлять маркер API в заголовки запросов. Чтобы протестировать API Центра приложений с помощью маркера API, выполните следующие действия.

1. Перейдите к спецификации OpenAPI в Центре приложений, чтобы изучить наши API.

2. В правом верхнем углу нажмите кнопку "Авторизовать ".

3. В разделе APIToken вставьте маркер API в значение и нажмите кнопку "Авторизовать".

   

4. Если в нем отображается "Авторизовано" и кнопка выхода, авторизация выполнена успешно. В правом верхнем углу всплывающего окна щелкните "X", чтобы выйти из всплывающего окна.

Создание первого вызова API с помощью OpenAPI (Swagger)

В этом разделе показано, как использовать страницу OpenAPI в Центре приложений с помощью вызова GET /v0.1/userAPI. Этот вызов API возвращает данные профиля пользователя.

1. Создайте маркер API, следуя приведенным выше инструкциям.
2. Авторизуйте страницу спецификации OpenAPI, чтобы использовать маркер API, следуя инструкциям в предыдущем разделе.
3. В разделе "Учетная запись" щелкните значок GET /v0.1/user.
4. В левом углу нажмите кнопку "Попробовать".
5. Нажмите кнопку "Выполнить " в разделе "Параметры ".
6. Замечательно! Теперь вы можете просмотреть ответ в разделе "Ответы ".

Отзыв токена API

В случае утечки маркера API необходимо немедленно отозвать его, чтобы предотвратить несанкционированный доступ к учетной записи Центра приложений.

Аннулирование токена API пользователя

1. Перейдите по адресу https://appcenter.ms.
2. В правом верхнем углу портала Центра приложений щелкните аватар учетной записи и выберите параметры учетной записи.
3. На средней панели выберите токены API пользователя из меню.
4. Установите флажок рядом с маркером, который вы хотите отозвать, и нажмите кнопку "Удалить " в правом верхнем углу.

Отзыв токена API приложения

1. Перейдите по адресу https://appcenter.ms.
2. Выберите приложение , для которого нужно отозвать маркер API.
3. В левой части нажмите кнопку "Параметры".
4. На средней панели выберите маркеры API приложений в меню.
5. Установите флажок рядом с маркером, который вы хотите отозвать, и нажмите кнопку "Удалить " в правом верхнем углу.