Marketplace "verified creator" flow (#17375)
This commit is contained in:
jmarlena
@@ -18,15 +18,23 @@ To learn about publishing {% data variables.product.prodname_actions %} in {% da
|
||||
|
||||
### Apps
|
||||
|
||||
Anyone can share their apps with other users on {% data variables.product.prodname_marketplace %} but only listings that are verified by {% data variables.product.company_short %} can include paid plans. For more information, see "[About verified creators](/developers/github-marketplace/about-verified-creators)."
|
||||
Anyone can share their apps with other users for free on {% data variables.product.prodname_marketplace %} but only apps owned by organizations can sell their app.
|
||||
|
||||
If you're interested in creating an app for {% data variables.product.prodname_marketplace %}, but you're new to {% data variables.product.prodname_github_apps %} or {% data variables.product.prodname_oauth_app %}s, see "[Building {% data variables.product.prodname_github_apps %}](/developers/apps/building-github-apps)" or "[Building {% data variables.product.prodname_oauth_app %}s](/developers/apps/building-oauth-apps)."
|
||||
To publish paid plans for your app and display the verified creator badge, you must complete the publisher verification process. For more information, see "[Applying for publisher verification for your organization](/developers/github-marketplace/applying-for-publisher-verification-for-your-organization)" or "[Requirements for listing an app](/developers/github-marketplace/requirements-for-listing-an-app)."
|
||||
|
||||
Once the organization meets the requirements, someone with owner permissions in the organization can publish paid plans for any of their apps. Each app with a paid plan also goes through a financial onboarding process to enable payments.
|
||||
|
||||
To publish apps with free plans, you only need to meet the general requirements for listing any app. For more information, see "[Requirements for all GitHub Marketplace listings](/developers/github-marketplace/requirements-for-listing-an-app#requirements-for-all-github-marketplace-listings)."
|
||||
|
||||
#### New to apps?
|
||||
|
||||
If you're interested in creating an app for {% data variables.product.prodname_marketplace %}, but you're new to {% data variables.product.prodname_github_apps %} or {% data variables.product.prodname_oauth_app %}s, see "[Building {% data variables.product.prodname_github_apps %}](/developers/apps/building-github-apps)" or "[Building {% data variables.product.prodname_oauth_app %}s](/developers/apps/building-oauth-apps)."
|
||||
|
||||
#### GitHub Apps vs. OAuth Apps
|
||||
|
||||
{% data reusables.marketplace.github_apps_preferred %}, although you can list both OAuth and {% data variables.product.prodname_github_app %}s in {% data variables.product.prodname_marketplace %}. For more information, see "[Differences between {% data variables.product.prodname_github_apps %} and {% data variables.product.prodname_oauth_app %}s](/apps/differences-between-apps/)" and "[Migrating {% data variables.product.prodname_oauth_app %}s to {% data variables.product.prodname_github_apps %}](/apps/migrating-oauth-apps-to-github-apps/)."
|
||||
|
||||
If you have questions about {% data variables.product.prodname_marketplace %}, please contact {% data variables.contact.contact_support %} directly.
|
||||
|
||||
### Publishing an app to {% data variables.product.prodname_marketplace %}
|
||||
### Publishing an app to {% data variables.product.prodname_marketplace %} overview
|
||||
|
||||
When you have finished creating your app, you can share it with other users by publishing it to {% data variables.product.prodname_marketplace %}. In summary, the process is:
|
||||
|
||||
@@ -38,13 +46,9 @@ When you have finished creating your app, you can share it with other users by p
|
||||
|
||||
1. Add a pricing plan. For more information, see "[Setting pricing plans for your listing](/developers/github-marketplace/setting-pricing-plans-for-your-listing)."
|
||||
|
||||
1. Check whether your app meets the requirements for listing on {% data variables.product.prodname_marketplace %} as a free or a paid app. For more information, see "[Requirements for listing an app](/developers/github-marketplace/requirements-for-listing-an-app)."
|
||||
|
||||
1. Read and accept the terms of the "[{% data variables.product.prodname_marketplace %} Developer Agreement](/articles/github-marketplace-developer-agreement/)."
|
||||
|
||||
1. Submit your listing for publication in {% data variables.product.prodname_marketplace %}, requesting verification if you want to sell the app. For more information, see "[Submitting your listing for publication](/developers/github-marketplace/submitting-your-listing-for-publication)."
|
||||
|
||||
An onboarding expert will contact you with any questions or further steps. For example, if you have added a paid plan, you will need to complete the verification process and complete financial onboarding. As soon as your listing is approved the app is published to {% data variables.product.prodname_marketplace %}.
|
||||
1. Submit your listing for publication in {% data variables.product.prodname_marketplace %}. For more information, see "[Submitting your listing for publication](/developers/github-marketplace/submitting-your-listing-for-publication)."
|
||||
|
||||
### Seeing how your app is performing
|
||||
|
||||
@@ -52,3 +56,7 @@ You can access metrics and transactions for your listing. For more information,
|
||||
|
||||
- "[Viewing metrics for your listing](/developers/github-marketplace/viewing-metrics-for-your-listing)"
|
||||
- "[Viewing transactions for your listing](/developers/github-marketplace/viewing-transactions-for-your-listing)"
|
||||
|
||||
### Contacting Support
|
||||
|
||||
If you have questions about {% data variables.product.prodname_marketplace %}, please contact {% data variables.contact.contact_support %} directly.
|
||||
|
||||
@@ -0,0 +1,38 @@
|
||||
---
|
||||
title: About verified creator badges
|
||||
intro: 'Learn about the verified creator badges that are shown for some listings for apps and actions on {% data variables.product.prodname_marketplace %}.'
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
---
|
||||
|
||||
### For GitHub Apps
|
||||
|
||||
Apps with the {% octicon "verified" aria-label="The verified badge" %}, or verified creator badge, are owned by an organization that has completed the publisher verification process.
|
||||
|
||||
|
||||
|
||||
To learn more about the publisher verification process, see "[Applying for publisher verification for your organization](/developers/github-marketplace/applying-for-publisher-verification-for-your-organization)."
|
||||
|
||||
For more information about the requirements for listing an app on {% data variables.product.prodname_marketplace %}, see "[Requirements for listing an app on {% data variables.product.prodname_marketplace %}](/marketplace/getting-started/requirements-for-listing-an-app-on-github-marketplace/)."
|
||||
|
||||
For information on finding apps to use, see "[Searching {% data variables.product.prodname_marketplace %}](/github/searching-for-information-on-github/searching-github-marketplace)."
|
||||
|
||||
### For GitHub actions
|
||||
|
||||
Actions with the {% octicon "verified" aria-label="The verified badge" %}, or verified creator badge, indicate that {% data variables.product.prodname_dotcom %} has verified the creator of the action as a partner organization.
|
||||
|
||||
|
||||
|
||||
For information on how to publish a GitHub action to {% data variables.product.prodname_marketplace %}, see "[Publishing actions in GitHub Marketplace](/actions/creating-actions/publishing-actions-in-github-marketplace)."
|
||||
|
||||
### About the previous verification process for apps
|
||||
|
||||
In addition to the verified creator badge, you'll also see badges for unverified and verified apps. These apps were published using the old method for verifying individual apps.
|
||||
|
||||
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** The new publisher verification process for apps replaces the previous process where individual apps were verified. The new publisher verification process is similar to the verification process for actions. If you have apps that were verified under the old process, these will not be affected by the changes. The {% data variables.product.prodname_marketplace %} team will contact you with details of how to migrate to organization-based verification.
|
||||
|
||||
{% endnote %}
|
||||
@@ -1,43 +0,0 @@
|
||||
---
|
||||
title: About verified creators
|
||||
intro: 'Each organization that wants to sell apps on {% data variables.product.prodname_marketplace %} must follow a verification process. Their identity is checked and their billing process reviewed.'
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
---
|
||||
|
||||
### About verified creators
|
||||
|
||||
A verified creator is an organization that {% data variables.product.company_short %} has checked. Anyone can share their apps with other users on {% data variables.product.prodname_marketplace %} but only organizations that are verified by {% data variables.product.company_short %} can sell apps. For more information about organizations, see "[About organizations](/github/setting-up-and-managing-organizations-and-teams/about-organizations)."
|
||||
|
||||
The verification process aims to protect users. For example, it verifies the seller's identity, checks that their {% data variables.product.product_name %} organization is set up securely, and that they can be contacted for support.
|
||||
|
||||
After passing the verification checks, any apps that the organization lists on {% data variables.product.prodname_marketplace %} are shown with a verified creator badge {% octicon "verified" aria-label="Verified creator badge" %}. The organization can now add paid plans to any of their apps. Each app with a paid plan also goes through a financial onboarding process to check that it's set up to handle billing correctly.
|
||||
|
||||
|
||||
|
||||
In addition to the verified creator badge, you'll also see badges for unverified and verified apps. These apps were published using the old method for verifying individual apps.
|
||||
|
||||
|
||||
|
||||
For information on finding apps to use, see "[Searching {% data variables.product.prodname_marketplace %}](/github/searching-for-information-on-github/searching-github-marketplace)."
|
||||
|
||||
### About the verification process
|
||||
|
||||
The first time you request verification for a listing of one of your apps, you will enter the verification process. An onboarding expert will guide you through the process. This includes checking:
|
||||
|
||||
- Profile information - The basic profile information is populated accurately and appropriately.
|
||||
- Security - The organization has enabled two-factor authentication.
|
||||
- Verified domain - The organization has verified the domain of the site URL.
|
||||
- Purchase webhook event - The event is handled correctly by the app.
|
||||
|
||||
When your organization is verified, all your apps are shown with a verified creator badge. You are now able to offer paid plans for any of your apps.
|
||||
|
||||
For more information about the requirements for listing an app on {% data variables.product.prodname_marketplace %}, see "[Requirements for listing an app on {% data variables.product.prodname_marketplace %}](/marketplace/getting-started/requirements-for-listing-an-app-on-github-marketplace/)."
|
||||
|
||||
{% data reusables.marketplace.app-transfer-to-org-for-verification %} For information on how to do this, see: "[Submitting your listing for publication](/developers/github-marketplace/submitting-your-listing-for-publication#transferring-an-app-to-an-organization-before-you-submit)."
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** This verification process for apps replaces the previous process where individual apps were verified. The current process is similar to the verification process for actions. If you have apps that were verified under the old process, these will not be affected by the changes. The {% data variables.product.prodname_marketplace %} team will contact you with details of how to migrate to organization-based verification.
|
||||
|
||||
{% endnote %}
|
||||
@@ -0,0 +1,34 @@
|
||||
---
|
||||
title: Applying for publisher verification for your organization
|
||||
intro: 'To offer paid plans for your app or to include the verified creator badge in your app listing, you must complete the publisher verification process for your organization.'
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
---
|
||||
|
||||
Publisher verification ensures that {% data variables.product.prodname_dotcom %} has a way to contact you, that you've enabled two-factor authentication for your organization, and that your organization's domain has been verified.
|
||||
|
||||
Once your organization has been verified, you can publish paid plans for your app. For information, see "[Setting pricing plans for your listing](/developers/github-marketplace/setting-pricing-plans-for-your-listing)."
|
||||
|
||||
To offer paid plans for your app, the app must be owned by an organization and you must have owner permissions in the organization. If your app is currently owned by a user account, you'll need to transfer the ownership of the app to an organization. For more information, see "[Transferring ownership of a GitHub App](/developers/apps/transferring-ownership-of-a-github-app)" or "[Transferring ownership of an OAuth App](/developers/apps/transferring-ownership-of-an-oauth-app)."
|
||||
|
||||
### Requesting publisher verification
|
||||
|
||||
{% data reusables.profile.access_profile %}
|
||||
{% data reusables.profile.access_org %}
|
||||
{% data reusables.organizations.org_settings %}
|
||||
1. In the left sidebar, click **Developer settings**.
|
||||
|
||||
1. Under "Developer settings", click **Publisher Verification**.
|
||||
|
||||
1. Under "Publisher Verification", complete the information in the checklist:
|
||||
- Ensure that your basic profile information is present and accurate. Also, make sure that you've included the best email address for support and updates from {% data variables.product.company_short %}.
|
||||
- Ensure that Two-factor authentication is enabled for your organization. For more information, see "[Requiring two-factor authentication in your organization](/github/setting-up-and-managing-organizations-and-teams/requiring-two-factor-authentication-in-your-organization)."
|
||||
- Submit a verified domain. For related information, see "[Verifying your organization's domain](/github/setting-up-and-managing-organizations-and-teams/verifying-your-organizations-domain)."
|
||||
|
||||
|
||||
|
||||
1. Click **Request Verification**. {% data variables.product.company_short %} will review your details and let you know once your publisher verification is complete.
|
||||
|
||||
### Further reading
|
||||
|
||||
For information about the process of publishing apps, see "[About GitHub Marketplace](/developers/github-marketplace/about-github-marketplace)."
|
||||
@@ -59,7 +59,7 @@ Once you've created a {% data variables.product.prodname_marketplace %} draft li
|
||||
|
||||
### Submitting your app
|
||||
|
||||
Once you've completed your {% data variables.product.prodname_marketplace %} listing, you can submit your listing for review from the **Overview** page. You'll need to read and accept the "[{% data variables.product.prodname_marketplace %} Developer Agreement](/articles/github-marketplace-developer-agreement/)," and then you can click **Submit for review**. After you submit your app for review, an onboarding expert will contact you with additional information about the onboarding process. You can learn more about the onboarding and security review process in "[Getting started with {% data variables.product.prodname_marketplace %}](/marketplace/getting-started/)."
|
||||
Once you've completed your {% data variables.product.prodname_marketplace %} listing, you can submit your listing for review from the **Overview** page. You'll need to read and accept the "[{% data variables.product.prodname_marketplace %} Developer Agreement](/articles/github-marketplace-developer-agreement/)," and then you can click **Submit for review**. After you submit your app for review, an onboarding expert will contact you with additional information about the onboarding process.
|
||||
|
||||
### Removing a {% data variables.product.prodname_marketplace %} listing
|
||||
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
---
|
||||
title: GitHub Marketplace Overview
|
||||
intro: 'Learn how you can share your app or action with the {% data variables.product.company_short %} community on {% data variables.product.prodname_marketplace %}.'
|
||||
mapTopic: true
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
---
|
||||
|
||||
|
||||
@@ -9,9 +9,12 @@ versions:
|
||||
free-pro-team: '*'
|
||||
---
|
||||
|
||||
{% topic_link_in_list /creating-apps-for-github-marketplace %}
|
||||
{% topic_link_in_list /github-marketplace-overview %}
|
||||
{% link_in_list /about-github-marketplace %}
|
||||
{% link_in_list /about-verified-creators %}
|
||||
{% link_in_list /about-verified-creator-badges %}
|
||||
{% link_in_list /applying-for-publisher-verification-for-your-organization %}
|
||||
|
||||
{% topic_link_in_list /creating-apps-for-github-marketplace %}
|
||||
{% link_in_list /requirements-for-listing-an-app %}
|
||||
{% link_in_list /security-best-practices-for-apps %}
|
||||
{% link_in_list /customer-experience-best-practices-for-apps %}
|
||||
|
||||
@@ -48,18 +48,21 @@ To protect your customers, we recommend that you also follow security best pract
|
||||
|
||||
### Requirements for paid apps
|
||||
|
||||
In addition to the requirements for all apps above, each app that you offer as a paid service on {% data variables.product.prodname_marketplace %} must also meet the following requirements:
|
||||
To publish a paid plan for your app on {% data variables.product.prodname_marketplace %}, your app must be owned by an organization that is a verified publisher. For more information about the verification process or transfering ownership of your app, see "[Applying for publisher verification for your organization](/developers/github-marketplace/applying-for-publisher-verification-for-your-organization)."
|
||||
|
||||
If your app is already published and you're a verified publisher, then you can publish a new paid plan from the pricing plan editor. For more information, see "[Setting pricing plans for your listing](/developers/github-marketplace/setting-pricing-plans-for-your-listing)."
|
||||
|
||||
To publish a paid app (or an app that offers a paid plan), you must also meet the following requirements:
|
||||
|
||||
- {% data variables.product.prodname_github_app %}s should have a minimum of 100 installations.
|
||||
- {% data variables.product.prodname_oauth_app %}s should have a minimum of 200 users.
|
||||
- All paid apps must handle {% data variables.product.prodname_marketplace %} purchase events for new purchases, upgrades, downgrades, cancellations, and free trials. For more information, see "[Billing requirements for paid apps](#billing-requirements-for-paid-apps)" below.
|
||||
- Publishing organizations must have a verified domain and must enable two-factor authentication. For more information, see "[Requiring two-factor authentication in your organization](/github/setting-up-and-managing-organizations-and-teams/requiring-two-factor-authentication-in-your-organization)."
|
||||
|
||||
When you are ready to publish the app on {% data variables.product.prodname_marketplace %} you must request verification for the listing.
|
||||
When you are ready to publish the app on {% data variables.product.prodname_marketplace %} you must request verification for the app listing.
|
||||
|
||||
{% note %}
|
||||
|
||||
The verification process is open to organizations. {% data reusables.marketplace.app-transfer-to-org-for-verification %} For information on how to do this, see: "[Submitting your listing for publication](/developers/github-marketplace/submitting-your-listing-for-publication#transferring-an-app-to-an-organization-before-you-submit)."
|
||||
**Note:** {% data reusables.marketplace.app-transfer-to-org-for-verification %} For information on how to transfer an app to an organization, see: "[Submitting your listing for publication](/developers/github-marketplace/submitting-your-listing-for-publication#transferring-an-app-to-an-organization-before-you-submit)."
|
||||
|
||||
{% endnote %}
|
||||
|
||||
|
||||
@@ -19,11 +19,13 @@ versions:
|
||||
|
||||
### About setting pricing plans
|
||||
|
||||
If you want to sell an app on {% data variables.product.prodname_marketplace %}, you need to request verification when you publish the listing for your app. During the verification process, an onboarding expert checks the organization's identity and security settings. The onboarding expert will also take the organization through financial onboarding. For more information, see: "[Requirements for listing an app on {% data variables.product.prodname_marketplace %}](/marketplace/getting-started/requirements-for-listing-an-app-on-github-marketplace/)."
|
||||
{% data variables.product.prodname_marketplace %} offers several different types of pricing plans. For detailed information, see "[Pricing plans for {% data variables.product.prodname_marketplace %}](/developers/github-marketplace/pricing-plans-for-github-marketplace-apps)."
|
||||
|
||||
{% data reusables.marketplace.app-transfer-to-org-for-verification %} For information on how to do this, see: "[Submitting your listing for publication](/developers/github-marketplace/submitting-your-listing-for-publication#transferring-an-app-to-an-organization-before-you-submit)."
|
||||
To offer a paid plan for your app, your app must be owned by an organization that has completed the publisher verification process and met certain criteria. For more information, see "[Applying for publisher verification for your organization](/developers/github-marketplace/applying-for-publisher-verification-for-your-organization)" and "[Requirements for listing an app on {% data variables.product.prodname_marketplace %}](/marketplace/getting-started/requirements-for-listing-an-app-on-github-marketplace/)."
|
||||
|
||||
{% data variables.product.prodname_marketplace %} offers several different types of pricing plan. For detailed information, see "[Pricing plans for {% data variables.product.prodname_marketplace %}](/developers/github-marketplace/pricing-plans-for-github-marketplace-apps)."
|
||||
If your app is already published with a paid plan and you're a verified publisher, then you can publish a new paid plan from the "Edit a pricing plan" page in your Marketplace app listing settings.
|
||||
|
||||
|
||||
|
||||
### About saving pricing plans
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Submitting your listing for publication
|
||||
intro: 'You can submit your listing for the {% data variables.product.prodname_dotcom %} community to use.'
|
||||
intro: 'To finish your app listing submission, you can request a review by an onboarding expert.'
|
||||
redirect_from:
|
||||
- /marketplace/listing-on-github-marketplace/submitting-your-listing-for-review
|
||||
- /developers/github-marketplace/submitting-your-listing-for-review
|
||||
@@ -8,30 +8,14 @@ versions:
|
||||
free-pro-team: '*'
|
||||
---
|
||||
|
||||
Once your app listing meets the {% data variables.product.prodname_marketplace %} requirements, you can submit your app. For an overview of the app listing requirements, see "[Requirements for listing an app](/developers/github-marketplace/requirements-for-listing-an-app)."
|
||||
|
||||
1. In the top left of the app listing page, click **Overview**. For information on finding your app listing page, see "[Drafting a listing for your app](/developers/github-marketplace/drafting-a-listing-for-your-app)."
|
||||
|
||||
|
||||
|
||||
Once you've completed the listing for your app, you'll see two buttons that allow you to request publication of the listing with or without verification. The **Request** button for "Publish without verification" is disabled if you have published any paid pricing plans in the listing.
|
||||
2. To submit your your completed app listing, click **Request review**.
|
||||
|
||||
|
||||
|
||||
|
||||
{% data reusables.marketplace.launch-with-free %}
|
||||
|
||||
After you submit your listing for review, an onboarding expert will reach out to you with additional information.
|
||||
|
||||
For an overview of the process for creating and submitting a listing, see "[About {% data variables.product.prodname_marketplace %}](/developers/github-marketplace/about-github-marketplace#publishing-an-app-to-github-marketplace)."
|
||||
|
||||
### Prerequisites for publishing with verification
|
||||
|
||||
Before you request verification of your listing, you'll need to integrate the {% data variables.product.prodname_marketplace %} billing flows and webhook into your app. For more information, see "[Using the {% data variables.product.prodname_marketplace %} API in your app](/developers/github-marketplace/using-the-github-marketplace-api-in-your-app)."
|
||||
|
||||
If you've met the requirements for listing and you've integrated with the {% data variables.product.prodname_marketplace %} API, go ahead and submit your listing. For more information, see "[Requirements for listing an app](/developers/github-marketplace/requirements-for-listing-an-app)."
|
||||
|
||||
{% data reusables.marketplace.app-transfer-to-org-for-verification %} For information on how to do this, see: "[Transferring an app to an organization before you submit](#transferring-an-app-to-an-organization-before-you-submit)" below.
|
||||
|
||||
### Transferring an app to an organization before you submit
|
||||
|
||||
You cannot sell an app that's owned by a user account. You need to transfer the app to an organization that is already a verified creator, or that can request verification for a listing for the app. For details, see:
|
||||
|
||||
1. "[Creating an organization from scratch](/github/setting-up-and-managing-organizations-and-teams/creating-a-new-organization-from-scratch)"
|
||||
|
||||
1. "[Transferring ownership of a GitHub App](/developers/apps/transferring-ownership-of-a-github-app)" or "[Transferring ownership of an OAuth App](/developers/apps/transferring-ownership-of-an-oauth-app)"
|
||||
An onboarding expert will reach out to you with additional information.
|
||||
|
||||
Reference in New Issue
Block a user