Collaboration

Discuss APIs and Apps, write reviews, and manage development cycle issues.

Table of Contents

1. How do I collaborate in the platform?
2. What are the differences between the App and API Boards?
3. What information is displayed on each Board?
4. Where can I find review information for each API?
5. How do I rate an API and write a review?

How do I collaborate in the platform?

The platform includes an API Board and App Board that can be used to promote APIs and Apps, manage issues associated with the development cycle, or enhance the visibility of topics relating to specific APIs or Apps.

API / App Board

API and App resources include a Board that includes both a topic board and a ticket management system.

• Developers / Team Members with access privileges to APIs or Apps can collaborate by posting a discussion topic, or can raise issues for a specific API or App by creating a ticket.
• Comments can be posted to board items or tickets. In addition, system generated tickets are posted for activities that require a line of approval (e.g., Request API Access, Team Invite, etc.).
• Board activity can be filtered within the respective resource.
• Feed entries associated with discussions and tickets are posted as notifications to the Dashboard of participating users (see How do I enable or disable notifications).
• Boards for both API and App resources have similar functionality, a set of sort controls that are common to both resources, and custom sort controls that are unique to the ticketing and post functions.

Back to top

What are the differences between the App and API Boards?

At the app level (My Apps > App Board), collaboration is made possible by inviting individuals to join your application development team. Team members can then create private discussions with other team members pertaining to Apps and the APIs an App is consuming, or create tickets pertaining to issues associated with application development.

At the API level (My Apps > Board), API developers and App Team members can post discussions pertaining to a specific API, or create tickets pertaining to issues associated with API operation.

Back to top

What information is displayed on each Board?

The following table illustrates the relationship of each newsfeed type to each Board, and shows the newsfeed types that display in the Dashboard.

	Discussion	Ticket	Alert	API Access Request	App Team Membership Requests
API Board	X	X	X	X	--
App Board	X	X	X	X	X
Dashboard	X	X	X	X	X

Back to top

Where can I find review information for each API?

Each API includes rating and review information submitted by platform community members. The information is available on the API Details page as follows:  

• Peer Rating - This section uses a star rating system to record positive feedback. A rating counter displays feedback for each rating number (1-5 stars), and displays an average rating.
• Peer Review - This section provides a list of written reviews submitted by the platform community for the current API. You can browse the reviews and filter information by Most Recent, Most Popular, Current or All versions, or enter a Search tag. You can also give the review a thumbs up in the "Was this review helpful?" section.

Back to top

How do I rate an API and write a review?

You can rate and write a review for an API on the API Details page as follows:

To rate an API:

1. Navigate to the API Details page for the API you would like to rate.
2. Go to Rate this API in the Peer Rating section and click the star that represents the level of positive feedback you would like to submit for the current API. The rating counter increments by one next to the star rating you selected and the star rating turns red.
3. You can change your rating by selecting another star.

To write a review for an API:

1. Navigate to the API Details page for the API you would like to review.
2. Go to the Write a Review section.
3. In the "Title" text box, enter a title for the API review.
4. In the "Review" text box enter the review contents.
5. After writing your review click Save. Your review is posted.
6. Community members can now read your review and rate whether it was helpful.

Back to top