Регистрация приложения GitHub

Вы можете зарегистрировать GitHub App в личная учетная запись или в любой организации, у вас есть.

В этой статье

О регистрации GitHub Apps

Вы можете зарегистрировать GitHub App в личная учетная запись, в организации, принадлежащей организации или в организации, которая предоставила вам разрешение на управление всеми приложениями, принадлежащими организации. Дополнительные сведения см. в разделе Добавление и удаление диспетчеров приложений GitHub в организации.

Пользователь или организация могут зарегистрировать до 100 GitHub Apps, но в учетной записи нет ограничения на количество GitHub Apps .

Регистрация GitHub App

  1. В правом верхнем углу любой страницы на GitHubщелкните фото профиля.

  2. Перейдите к настройкам учетной записи.

    • Для приложения, принадлежащих личная учетная запись, щелкните Параметры.
    • Для приложения, принадлежащих организации:
      1. Щелкните Your organizations (Ваши организации).
      2. Справа от организации щелкните Параметры.

  3. На левой боковой панели щелкните Параметры разработчика.

  4. На левой боковой панели щелкните GitHub Apps.

  5. Нажмите кнопку Создать приложение GitHub.

  6. В разделе "Имя приложения GitHub" введите имя приложения. Вы должны выбрать четкое и короткое имя. Имя приложения (преобразовано в нижний регистр, пробелы заменены -и специальные символы заменены) будут отображаться в пользовательском интерфейсе при выполнении действия приложения. Например, My APp Näme будет отображаться как my-app-name.

    Имя должно быть уникальным для GitHub. Вы не можете использовать то же имя, что и существующая учетная запись GitHub, если это не ваше имя пользователя или организации.

  7. При необходимости в разделе "Описание" введите описание приложения. Пользователи и организации увидят это описание при установке приложения.

  8. В поле "URL-адрес домашней страницы" введите полный URL-адрес веб-сайта приложения. Если у вас нет выделенного URL-адреса и код приложения хранится в общедоступный репозиторий, можно использовать этот URL-адрес репозитория. Кроме того, можно использовать URL-адрес организации или пользователя, которому принадлежит приложение.

  9. При необходимости в разделе "URL-адрес обратного вызова" введите полный URL-адрес для перенаправления после авторизации установки пользователем.

    Можно ввести до 10 URL-адресов обратного вызова. Чтобы добавить дополнительные URL-адреса обратного вызова, нажмите кнопку "Добавить URL-адрес обратного вызова".

    Если приложению не нужно действовать от имени пользователя (не нужно создавать маркер доступа пользователя), это поле будет игнорироваться. Если приложение использует поток устройств вместо потока веб-приложения для создания маркера доступа пользователя, это поле будет игнорироваться.

    Дополнительные сведения о URL-адресе обратного вызова см. в разделе "Сведения о URL-адресе обратного вызова авторизации пользователя". Дополнительные сведения о создании маркера доступа пользователя для действия от имени пользователя см. в разделе "[AUTOTITLE" иПроверка подлинности с помощью приложения GitHub от имени пользователя](/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)".

  10. При необходимости, чтобы запретить истечение срока действия маркеров доступа пользователей, отмените выбор маркеров авторизации пользователей. GitHub настоятельно рекомендует оставить этот параметр выбранным. Дополнительные сведения об обновлении маркеров с истекшим сроком действия и преимуществах маркеров доступа пользователей см. в разделе "Обновление маркеров доступа пользователей". Если приложению не нужно создавать маркер доступа пользователей, это поле будет игнорироваться.

  11. При необходимости, чтобы пользователи запросили авторизацию приложения при его установке, выберите "Запросить авторизацию пользователя" (OAuth) во время установки. Если пользователь авторизует приложение, приложение может создать маркер доступа пользователя для выполнения запросов API от имени пользователя и действия приложения атрибутов для пользователя. Дополнительные сведения см. в разделе "[AUTOTITLE" и "Проверка подлинности с помощью приложения GitHub от имени пользователя](/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)".

  12. При необходимости, если вы хотите использовать поток устройств для создания маркера доступа пользователей, выберите "Включить поток устройств". Дополнительные сведения см. в разделе Создание маркера доступа пользователя для приложения GitHub.

  13. При необходимости в разделе "URL-адрес установки" введите URL-адрес для перенаправления пользователей после установки приложения. Если после установки требуется дополнительная настройка, вы можете использовать этот URL-адрес, чтобы сообщить пользователям, какие действия необходимо выполнить после установки. Дополнительные сведения см. в разделе Сведения о URL-адресе установки.

    Если вы выбрали авторизацию пользователя запроса (OAuth) во время установки на предыдущем шаге, вы не сможете ввести URL-адрес здесь. Вместо этого пользователи будут перенаправлены на URL-адрес обратного вызова в рамках потока авторизации, где можно описать дополнительную настройку.

  14. При необходимости, если вы хотите перенаправить пользователей на URL-адрес установки после обновления установки, выберите "Перенаправление" при обновлении. Обновление включает добавление или удаление репозитория для установки. Если значение "URL-адрес установки" пусто, это будет игнорироваться.

  15. При необходимости, если вы не хотите, чтобы приложение получало события веб-перехватчика, отмените выбор "Активный". Например, если приложение будет использоваться только для проверки подлинности или не требует ответа на веб-перехватчики, отмените выбор этого параметра. Дополнительные сведения см. в разделе Использование веб-перехватчиков с приложениями GitHub.

  16. Если вы выбрали "Активный " на предыдущем шаге в разделе "URL-адрес веб-перехватчика", введите URL-адрес, в который GitHub должен отправлять события веб-перехватчика. Дополнительные сведения см. в разделе Использование веб-перехватчиков с приложениями GitHub.

  17. При необходимости, если вы выбрали "Активный " на предыдущем шаге в разделе "Секрет веб-перехватчика", введите секретный маркер для защиты веб-перехватчиков. GitHub настоятельно рекомендует задать секрет веб-перехватчика. Дополнительные сведения см. в разделе Использование веб-перехватчиков с приложениями GitHub.

  18. Если вы ввели URL-адрес веб-перехватчика, в разделе "Проверка SSL" выберите, следует ли включить проверку SSL. GitHub настоятельно рекомендует включить проверку SSL.

  19. В разделе "Разрешения" выберите необходимые для приложения разрешения. Для каждого разрешения выберите раскрывающееся меню и щелкните "Только** для чтения", " Чтение" и** "Запись" или "Нет доступа". Необходимо выбрать минимальные разрешения, необходимые для приложения. Дополнительные сведения см. в разделе Выбор разрешений для приложения GitHub.

  20. Если вы выбрали "Активный " на предыдущем шаге, чтобы указать, что приложение должно получать события веб-перехватчика, в разделе "Подписка на события", выберите события веб-перехватчика, которые вы хотите получить. Разрешения, выбранные на предыдущем шаге, определяют, какие события веб-перехватчика доступны. Дополнительные сведения о каждом событии веб-перехватчика см. в разделе "События и полезные данные веб-перехватчика".

  21. В разделе "Где можно установить приложение GitHub?", выберите только в этой учетной записи или любой учетной записи.{ % ifversion ghec %} Если вы используете Enterprise Managed Users, только в этой учетной записи будут отключены учетные записи пользователей. Вместо любой учетной записи параметр будет читать это предприятие.{ % endif %} Дополнительные сведения о параметрах установки см. в разделе "Преобразование приложения GitHub в общедоступное или частное".

  22. Нажмите кнопку Создать приложение GitHub.

Следующие шаги

После регистрации GitHub Appвы хотите написать код, чтобы сделать GitHub App делать что-то. Примеры написания кода см. в следующих примерах:

Вы должны стремиться следовать рекомендациям. Дополнительные сведения см. в разделе Рекомендации по созданию приложения GitHub.

После полной сборки данных GitHub App можно установить GitHub App и поделиться данными GitHub App с другими пользователями. Дополнительные сведения см. в разделе "[AUTOTITLE" и "Установка собственного приложения GitHub](/apps/sharing-github-apps/sharing-your-github-app)".

Вы всегда можете вносить изменения в параметры данных GitHub App. Дополнительные сведения см. в разделе Изменение регистрации приложения GitHub.