Work as a team · Lesson 19 of 20
Publish your API on the marketplace
Register your organization (or create a personal profile), choose Publish to marketplace on a collection, and track how developers use it.
The marketplace is a public directory of API collections. A listing shows your endpoints, documentation and track record, and developers can star it or fork it into their own workspace to try it in seconds. Publishing is free.
1. Choose who publishes
Every API on the marketplace has a publisher:
- An organization, for a company or team. It has a logo, a public page and a verified badge once you prove you own its website's domain. Register one at Register an organization: three short steps (name and logo, company details, review). Signing up with Organization selected takes you there after you verify your email.
- A personal profile, to publish under your own name. Create it from Your marketplace.
Registering an organization also creates its team workspace (for example Acme Payments APIs). That is where its published collections live, and colleagues you add to the team can work on them with you.
During registration you also decide two things, both changeable later in the profile's Visibility settings: whether the profile appears on the marketplace at all, and whether Google and other search engines may list your pages. Search engines are only told about your pages once you say yes.
2. Publish a collection
- In the app, click ⋯ next to the collection and choose Publish to marketplace… (it is also under Share).
- Under Publish as, pick your organization or your personal profile.
- Fill in a title, a one-line summary, a category and a few tags. The description supports Markdown.
- Click Publish. The page goes live at
swastik.codes/marketplace/<handle>/<api>.
The collection can be anywhere: in the Scratch Pad, your personal workspace or another team. When it is not already in the publisher's workspace, the dialog says so (A copy goes to "Acme Payments APIs"), the button reads Copy and publish, and the copy is what gets published. Edit that copy afterwards to update the public page; your original stays where it was.
Everything in the collection becomes public except secret variables and your current values, as on published documentation. Remove tokens and API keys from URLs, headers and bodies before you publish.
3. Help developers find it
Developers find APIs by searching, browsing categories and sorting. A few choices decide whether yours shows up:
- Use the words people search for. Marketplace search matches the start of words in the title, summary, tags and your publisher name:
payfinds Payments API, but nothing finds a word that is not there. Put the product name and what it does in the title (Acme Payouts API), and synonyms in tags (upi,payouts,settlements). - Pick the closest category. It decides where the API appears when people browse by category; tags cover the rest.
- Write the summary for the card. It is the first thing people read in results and the description search engines show. One or two sentences: what it does and for whom.
- Trending ranks the stars, forks and views of the last 14 days (forks count most), then all-time stars and forks, with a boost for verified organizations. Keeping the collection useful and up to date is what moves it.
- Unlisted APIs and hidden profiles never appear in search or categories, and search engines only list your pages once you allowed it under Visibility.
Changes to a listing or your profile show on the marketplace straight away. Edits inside the collection (its endpoints) and star and view counts can take up to a minute to catch up.
4. Earn the verified badge
Organizations get a Verification tab with one DNS TXT record to add at your domain provider, for example _swastik-codes.acme.com. Click Verify once it is in place; the badge then shows on your page and on every API you publish. Unverified organizations can still publish, just without the badge.
5. Track and manage
Open Your marketplace from the account menu (or swastik.codes/profile) and choose the organization:
- Insights: stars, forks and views per day and per API. Hover or tap the (i) next to each number to see how it is counted.
- APIs: edit a listing, switch it between listed and unlisted (reachable only by its link), or remove it.
- Profile: logo, details and visibility settings.
- Members: who can publish with you (the team's admins).
Troubleshooting
- It asks me to create a personal profile, but I registered an organization. Pick the organization under Publish as. If it is not listed, you are not an admin of its team: ask an admin to publish, or to make you one.
- "Verify your email" appears. Publishing and registering an organization need a verified email address. Use the link in the email we sent, or resend it from the account menu.
- The page says it is not found. The profile may be hidden from the marketplace: turn it back on under Profile › Visibility.