Portal Content
API Fragments Portal
- Description must be completed
- Not extensive
- Concise
- Clear and useful
- Use case
- Always add a use case showing the usage of the asset
APIs Specification Portal
-
Portal Content
- Description must be completed, not extensive, concise, clear and useful
- Include a How-To (preferable a short video/gif showing how to request API access and how the Portal works)
- Include authentication / authorization requirements details for accessing the API (e.g. client ID & client secret, OAuth 2.0)
-
API Console
- Make sure it is accessible
- It should work for each resource and method
- Include Mocking Service instance
-
API Notebook
- Optional
- Include if your API is a part of a process workflow and there is a need to show the usage