Publishing your API

Before you publish

The Listing completeness panel on the General tab must be all green:

• ☑ Category chosen
• ☑ Short description written
• ☑ Base URL set
• ☑ At least one endpoint in Definitions
• ☑ Documentation written in Docs

We also strongly recommend, before going live:

• a logo;
• at least one plan (consumers can't subscribe without one), ideally including a free one;
• a secret header so nobody can bypass the gateway (how);
• a test call from the playground once published, to check the whole path works end to end.

Publishing

Click Publish (top right). Your API immediately:

• becomes Public and appears in the marketplace, its category, search and collections;
• gets its secure gateway address: https://<your-slug>.p.apihiver.com;
• is included in the sitemap, so search engines can find it.

After publishing

• Edits go live straight away. Changes to descriptions, docs, endpoints and plans appear on your public listing as soon as you save them.
• Adding endpoints makes them callable through the gateway immediately. Removing one stops the gateway forwarding calls to it.
• Changing the base URL switches all traffic to the new address, so make sure the new server is ready first.
• Tell subscribers about important changes with a message from Community.

Staying in good standing

APIHiver may suspend an API that breaks our Terms of Service, for example one that is misleading, unlawful or consistently unavailable.