API Definition Interactive Documentation Access Control
The
Interactive Documentation Access Control setting (Design > APIs) for an API in the Mashery Control Center allows you to specify a required Administrative Role or Portal Access Group required to see the Interactive Documentation items on the
Interactive Documentation page. The
Interactive Documentation Docs or
API Explorer feature on the Developer Portal provides an interactive interface for your developers to learn how to use your API. Through Interactive Documentation, your developer will quickly be able to make API requests and see the live responses returned from your API.
For the selected Interactive Documentation item, use the Access Control menu to specify the roles that will have access to the API definition in the portal. Click a role from the Unselected list to give access; click a role from the Current list to remove access. The portal will display only those Interactive Documentation items that are appropriate for the user's given roles.
How to Restrict Access to the Interactive Documentation Page
The Interactive Documentation page can be accessed on any portal by clicking the API Explorer link or by entering <domain_name>/interactive-documentation in the address bar. On some portals, developers can access Interactive Documentation without logging on to the portal, whereas in other portals, developers are required to have an account created to access Interactive Documentation.
By restricting API access to a specific group of users or developers, you can ensure that other users do not see the API. In general, when a developer/user has not been assigned any role, the access settings configured for the Everyone role are applied to the developer/user.