API Forum

Discuss APIs and report development cycle issues relating to APIs.

API Platform Version: 8.1 and later

Table of Contents

  1. How do I create a discussion about an API?
  2. How do I report a problem with an API using the API Forum?
  3. How do I change the priority of a problem I reported?
  4. How do I filter information in the API Forum?
  5. How do I delete an API Forum item?
  6. Related Topics

How do I create a discussion about an API?

You can use the API Forum to create a discussion about a specific API. Common discussion topics include questions, suggestions, feature requests, announcements, and update information about the current API. Remember to specify the API version.

To create a discussion:
  1. Navigate to the forum for your API: APIs > choose API > Forum.
  2. Click the Discussion topic type.
  3. In the What do you want to discuss? text box, type your topic text. If Markdown is available, you can also add formatting and use inline images and uploaded files. For information about the Markdown feature, see Using Markdown.
  4. In the Add a short title text box, enter a description for your post.
  5. Enter one or more tags to identify the discussion. Tags are used by the search feature to help users find information.
  6. Click Submit.

Back to top

How do I report a problem with an API using the API Forum?

You can use the API Forum to submit trouble tickets associated with one or more APIs.

Any platform member can open a ticket for an API.

Submitted tickets are visible in the API Forum, App Forum, and Dashboard of those platform members who decide to follow an API.

To report a problem for an API:
  1. Navigate to the forum for your API: APIs > choose API > Forum.
  2. Choose the Ticket topic type.
  3. In the What issues would you like to report? text box, type your topic text. To add new paragraphs or lines, press Return. If Markdown is available, you can also add formatting and use inline images and uploaded files. For information about the Markdown feature, see Using Markdown.
  4. In the Add a short title text box, enter a description for your post.
  5. Enter one or more tags to identify the ticket. Tags are used by the search feature to help users find information.
  6. Select the priority for the ticket from the Priority drop-down menu (Minor, Major, Critical).
  7. Select the app the ticket pertains to from the My Apps drop-down menu.
  8. Select the API version the ticket pertains to from the API Version drop-down menu.
  9. Select an implementation (Sandbox or Live) from the Implementation drop-down menu.
  10. Click Submit to post your ticket.
  11. Your ticket is created and a notification is posted to your Dashboard and the Dashboard of your team members for the selected application.
  12. After your ticket is created you can use the Edit Priority function to upgrade or downgrade the ticket priority.
  13. See How do I filter information in the API Forum? to manage and view the display of existing tickets.

Back to top

How do I change the priority of a problem I reported?

You can change the priority of an API ticket if you created it yourself or are an administrator for the API (API Administrator or Business Administrator).

To change the priority of an API ticket through the API Forum:
  1. Navigate to the forum for your API: APIs > choose API > Forum.
  2. In the Type drop-down, choose Tickets.
  3. Find the ticket on the list, and click Edit Priority.
  4. Write a comment, choose a new priority, and click Confirm.

Back to top

How do I filter information in the API Forum?

The following tables illustrate sort controls for the default, Post, Ticket, and Alert views for the API Forum.

API Sort Controls (All View)

Sort Control Name Options
Type All, Discussions, Tickets, Alerts
Apps All, Selected App
Sort By Most Popular, Most Marked, Most Recent
Search Tag or Keyword

 

API Sort Controls (Discussion View)

Sort Control Name Options
Type All, Discussions, Tickets, Alerts
Sort By Most Popular, Most Recent, Most Marked
Search Tag or Keyword

API Sort Controls (Ticket View)

Sort Control Name Options
View All, Discussions, Tickets, Alerts
Apps All, Selected App
Sort By Most Recent, Most Marked, Most Commented
Search Tag or Keyword

 

API Sort Controls (Alert View)

Sort Control Name Options
View All, Discussion, Tickets, Alerts
API All, Selected
Sort By Most Recent, Most Marked, Most Commented
Search Tag or Keyword

Back to top

How do I delete an API Forum item?

The API Forum allows you to delete discussion, ticket, or alert post types. When you delete a post all comments entered by site users are also deleted. You can only delete posts you have personally added.

To delete a discussion, ticket, or alert:
  1. Access the API Forum that includes a discussion, ticket, or alert you would like to delete.
  2. In the upper right-hand corner of the post, click x to the right of the post icon.
  3. The message "Are you sure you want to delete this?" displays. Click OK to delete the post.

Back to top