Community Manager Developer Portal Help Content Overview
Brief overview of the Community Manager developer portal, with links to more information.
Table of Contents
Introduction and Basics:
- Community Manager Developer Portal overview
- How the help content is organized
- Overview of general help content (Basics section)
- Site Themes
- Additional Getting Started resources
- Video resources
App Developer Help:
API Admin Help:
Groups/Collaboration Help:
Business Admin Help:
Site Admin Help:
Additional Developer Portal help content:
Introduction and Basics:
Community Manager Developer Portal overview
The Community Manager developer portal user interface provides a platform for app developers to easily explore, test, and connect with different APIs. It provides easy access in a secure environment, allows you to create teams and test different APIs, and offers metrics and other information relating to APIs.
How the help content is organized
The help content for the Community Manager developer portal is structured by role, so that the information you most need is together, depending on your key activity. There is also a general information section for all users. The key sections of the help content are:
- Basics: see Overview of general help content (Basics section) below
- App developer help: see App Developer Help
- API Admin help: see API Admin Help
- Groups/Collaboration help: see Groups/Collaboration Help
- Business Admin help: see Business Admin help
- Site Admin help: see Site Admin help
- Help for other scenarios, such as developer portal add-ons: see Additional Developer Portal help content
Overview of general help content (Basics section)
The general help content covers information that is applicable to all users, such as:
- Signing up
- Account management
- Navigation
- Groups
- Forums
- Using the Search feature
- Technical support resources
- Glossary of terms
For links to all the topics in the Basics section, see Basics section table of contents.
Site Themes
There are several variations available for the Community Manager developer portal. Unless you're a Site Admin, you might not know which theme you're using. The user interface for a theme also sometimes changes between versions. In some cases the navigation is different depending on the theme/version, so it might be helpful for you to know which theme/version you're using.
The content below will help you to recognize the theme that you're using.
- Hermosa Theme
- Bonita Theme
- Simple Developer Theme
- Dev Ops Theme
- Default Theme (versions prior to 2020.2.0)
Additional Getting Started resources
Some of the available help content is designed to help you get up and running with a specific feature or activity on the Community Manager developer portal. For example:
Video resources
Some video material is available, demonstrating different aspects of the Community Manager developer portal user interface.
For links to video resources, see Introductory Video Content.
App Developer Help:
App developer role
If you are an app developer, you can use the Community Manager developer portal to:
- Create and managing apps
- View different APIs, look at the API documentation, and test APIs, either on their own or with your app
- Connect to APIs that you want to use with your app
- View analytics for your app
- Secure your app
App developer help
The following help content is available for app developers:
API Admin Help:
API Admin role
API Admin is one of the roles defined in the Akana API Platform. Each API must have at least one Admin, and can have more. The API Admin approves or rejects connection requests, moderates the API's Forum, views and manages alerts and trouble tickets, and manages documents, policies, and other information associated with the API. The API Admin can also view performance and usage data for the entire API, and can invite others to be Admins for the same API.
API Admin content
The following content is available for API administrators:
- API Administration
- API Administration: Overview
- Add an API
- Using API Designer
- Managing API Implementations
- API Testing with Test Client
- API Settings and Visibility
- Managing Contracts for your API
- Forum Moderation
- Working with Physical Services
- OAuth Support
- Promoting an API
- Content Development Guidelines for API Admins
- API Documentation Maintenance
- API Documentation Visibility Tagging
- Legal Agreement Maintenance
- API Admin Management
- API Monitoring
- API Documentation Visibility
- API Documentation
- API Testing and Use Cases
Groups/Collaboration Help:
Collaboration - Overview
Collaboration is key for app developers and API team members, as well as Business Admins and Site Admins.
The Community Manager developer portal supports collaboration in many ways, including:
- Group/team creation and management, including notifications to team members when there are changes in the team
- The ability to create a private team in the context of an API
- Forums that allow you to review apps and APIs as well as create discussions and tickets.
- The ability to rate apps and APIs.
Types of Groups
There are two main types of groups in the Community Manager developer portal:
- Groups that are independent of an app or API. A group in this context is just a team of one or more developer portal users.
- Private groups that exist only in the context of a specific API, under specific circumstances.
Collaboration content
The following content is available to help you effectively collaboration in the Community Manager developer portal, via app and API groups, forums, posts, and tickets:
For additional information about groups and forums, see Groups.
Business Admin Help:
Business Admin role
One of the roles defined in the Akana API Platform is that of the Business Administrator. A business can own one or more APIs and apps, and must have at least one Administrator. The Business Administrator automatically has administrator rights over all the APIs and apps owned by the business as well as all the users who are part of the business.
For links to information about Business Admin activities in the Community Manager developer portal, see Business Administration.
Business Admin content
When you log in to the Community Manager developer portal, you are at the root business level, and there is a set of Business Admin functions available at that level. Changes made in these pages affect all businesses.
When you navigate to a specific business, there is an additional set of functions available. These functions only affect the specific business that you're in.
For general information about the Business Admin role, see Business Admin Responsibilities.
The two sets of Business Admin functions are broken up in the lists below:
Business Admin functions at the root level
The following content is available at the root level, via More > Admin, for users with the Business Administrator role. For more information and an illustration, see Business Admin: left-menu options.
Business Admin functions at the business level
The following content is available to help users with the Business Administrator role in the context of a specific business on the platform, via More > Organizations. For more information and an illustration, see What functions are available to the Business Administrator for a specific organization on the platform?
- Business APIs
- Business Apps
- Monthly Report (root business only)
- Organizations
- Policies
- Business Processes
- Models
- Business Scripts
- Security (Roles)
- Actions (Export/Import)
Site Admin Help:
Site Admin role
One of the roles defined in the Akana API Platform is that of the Site Admin. The Site Admin is responsible for keeping the site running smoothly, performing activities such as configuring site settings, managing users and other Site Admins, customizing the user interface, uploading and managing site content such as the landing page, online help, and developer agreement, and configuring login domains and custom workflows in the Community Manager developer portal user interface.
For links to information about Site Admin activities, see Site Admin Content Overview.
Site Admin content
The following content is available for users with the Site Administrator role:
- Site Admin Content Overview
- Site Admin Responsibilities
- Legal Agreements
- Configuration
- Settings
- Site Settings
- Site Admins
- User Accounts
- Workflows
- Test Client
- Search Configuration
- Content Development Guidelines for Simple Dev Theme
- Security Challenge Questions
- Country Codes
- Community Manager developer portal Customization and Branding
- File Manager
- Managing Lifecycle Coordinator
- Using Custom Metadata in the Community Manager developer portal
- Login Domains
- Admin Console Settings
- Promotion Feature
Additional Developer Portal help content:
Lifecycle Coordinator
The following content is available for the Lifecycle Coordinator product:
- Promotion Feature
- Managing Lifecycle Coordinator
- Lifecycle Coordinator Promotion Guide
- Lifecycle Coordinator Promotion: Sample Topologies
Lifecycle Repository
The following content is available for the Lifecycle Repository product: