Portal layout
Two portals, one navigation
API-dex ships two portals. Both offer the same areas; they place the main navigation differently.
| Internal developer portal | External developer portal | |
|---|---|---|
| Main navigation | Left sidebar under Developer Portal | Top bar: Home, Apis, Applications, Teams, Admin |
| Organisation Settings | Gear icon in the narrow strip beside the sidebar | The /settings address of your portal; there is no menu entry |
| Feature request or bug report | Bug icon in the narrow strip | The /issues address of your portal |
| Home | Dashboard with recent API activity and shortcuts | Landing page with a product introduction and Explore Products |
| Settings sections | Settings sidebar | Tabs at the top of the Settings page |
The rest of this documentation says "open APIs" and means: select it in the main navigation, wherever your portal places it. The page titles are the same in both portals: My Applications, My Teams, Admin.
Main areas of the screen
- Main navigation. Home, APIs, My Applications and My Teams for everyone; Documentation once a documentation tree is published; Companies where company management is enabled; and Admin for administrators. On the external portal Admin is a menu with Permission Groups, Logging, Pending Approvals and Environments.
- Top bar. Search, language, your profile menu and the environment control. The profile menu shows your name and email and contains My Analytics and Logout.
Every list and detail page reflects the currently selected environment.
Environment control
The Environment control in the top bar shows the display name of the environment you are using.
- Select it to open the Switch to environment list.
- Each entry shows the environment name and its gateway type (Apigee, Gravitee or Azure).
- Selecting another environment reloads the catalog, applications, credentials and analytics for that environment.
The control lists only the environments your role is allowed to access.
Search
The search icon in the top bar opens a Search… field. Press Enter to open the Search pages results page for your query. The search covers the documentation pages your organisation has published in the portal, not the API catalog; the catalog has its own Search by name filter. When no documentation tree is published, every query returns No results were found.
Documentation tree and release notes
When a documentation tree is published, Documentation in the main navigation opens it, and a secondary sidebar lists its sections and pages. Release notes are the announcements your organisation publishes to its own portal users about new features, fixes and notices; they open from the same secondary sidebar. These are the organisation's own notes. The version history of API-dex itself is the Changelog.
Language
The language control in the top bar switches between the display languages the administrator has enabled under Settings → General. Arabic renders the whole portal right to left. See Manage settings.
Signing in and out
- Sign in: open your API-dex address and complete your organisation's sign-in flow. You land on Home, or on the page you were trying to open.
- Sign out: select your avatar in the top bar, then Logout.