Exchange API icon

Exchange API

1.0.x
(0 reviews)
An API for working with Anypoint Exchange and assets in Exchange

Overview

Use Exchange API version 1 to create, share, search, and manage assets and their documentation in Exchange, customize the public portal, and manage organizations. Anypoint user permissions control the available operations.

Exchange API version 1 was previously known as the Exchange Experience API or xAPI.

Only the API endpoints documented here are supported. The Exchange user interface often uses other endpoints, but if those endpoints are not documented here, then they are not supported for external use, and they may change at any time. If you cannot satisfy your use case with the documented endpoints, please contact your MuleSoft representative.

Assets

Operations:

  • Create assets of these types:
    • RAML API
    • OAS API
    • WSDL API
    • HTTP API
    • Custom
    • RAML Fragment
    • API Group
  • Edit asset metadata.
  • Delete an asset with a hard delete or a soft delete.
  • Search assets by organization and other parameters including type, description, tags, asset documentation, and RAML content.
  • Request API access for APIs.
  • Share assets with specific users.
  • Share assets in the public portal.
  • Manage asset versioning.
  • Manage asset tags.
  • Manage organization applications.
  • Perform other related operations.

Asset Documentation

When you create an asset in Exchange, you can edit and customize the asset documentation before publishing the asset to an organization. Documentation pages can store content in multiple formats such as Markdown and HTML.

Operations:

  • Edit the asset documentation in a draft mode.
  • Create and search documentation pages.
  • Create and search reviews with ratings for the asset versions.
  • Publish the asset documentation.

Public Portal

An organization can share APIs on a public portal so developers outside the organization can access the APIs. Exchange public portals replace what was known as a developer portal.

Operations:

  • Share assets on the public portal.
  • Customize the public portal:
    • Edit the customization in a draft mode.
    • Create documentation pages.
    • Publish the customization for everyone.

Access the API

Create an Anypoint platform account. If your organization already has an Anypoint platform account, request an invitation by email from your organization administrator.

API Notebooks

To test the methods that this API provides and show example responses, the API Notebooks section can be used.

There is no charge for using this API.

For more information, visit:

https://docs.mulesoft.com/exchange/exchange2-faq

Reviews