Landing Page
The first thing any consumer of an API will see is the landing page. Just like the home page of a website, the API landing page should speak to the target audience, telling them of the value the API possesses and providing single click access to every aspect of the API.
On the API landing page, the first thing a user should see is a short, descriptive paragraph explaining the value delivered by the API. There is no need talk about REST or JSON, API owners should explain what problems the API solve, in a language anyone will understand. Don’t assume anything about visitors. In all likelihood the user will know nothing about the company, products and history.
Each API landing page should speak to as wide an audience as possible, even non-developers, rising above the technological jargon and clearly explain the business value delivered by an API.
|
|
Tweet |
|
|
API Design
API Deployment
API Management
API Discovery
API Integration
