Discover Portal APIS

Overview

As a portal consumer (end user), you need to find the right API and understand what it does before requesting access. This workflow covers the discovery surface of an API Experience Hub (AEH) portal: listing and searching published assets, inspecting a specific asset's metadata, reading its terms of use, and fetching its documentation pages and downloadable resources.

What you'll build: A short list of candidate APIs and the supporting docs you need to decide which one to request access to.

Prerequisites

Before starting, ensure:

  1. Authentication ready

    • Valid portal-consumer Bearer token
    • Membership in the portal (see manage-portal-members-and-prospects for the admin flow that grants this)

  2. Portal context known

    • targetOrganizationId — the Anypoint organization hosting the portal
    • portalId / targetPortalId — the specific portal you are browsing

Step 1: List Published Assets in the Portal

Start with a broad browse of everything the portal publishes.

api-experience-hub-consumer.listAssetsCommunityAsset 
$ curl -X GET ${baseUrl}/xapi/v1/portals/{targetOrganizationId}/{targetPortalId}/assets \
  -H "Authorization: Bearer ${authToken}" \
  -H "Content-Type: application/json"
Captured Variables
assets $.assets[*]
groupId $.assets[*].groupId
assetId $.assets[*].assetId
minorVersion $.assets[*].minorVersion

Step 2: Search for Specific Assets

Narrow the list with a keyword, tag, category or asset-type filter.

api-experience-hub-consumer.searchCommunityAssets 
$ curl -X POST ${baseUrl}/xapi/v1/portals/{targetOrganizationId}/{targetPortalId}/assets/search \
  -H "Authorization: Bearer ${authToken}" \
  -H "Content-Type: application/json"
Captured Variables
matchingAssets $.assets[*]

Step 3: Open an Asset's Detail Page

Retrieve the full metadata of one asset — summary, description, contact info, classifier, all visible minor versions.

api-experience-hub-consumer.getAssetDetails 
$ curl -X GET ${baseUrl}/xapi/v1/portals/{targetOrganizationId}/{targetPortalId}/assets/{groupId}/{assetId}/{minorVersion}/details \
  -H "Authorization: Bearer ${authToken}" \
  -H "Content-Type: application/json"
Captured Variables
assetDetails $

Step 4: Read Terms and Conditions

Before requesting access, consumers should read the terms published for the asset.

api-experience-hub-consumer.getTermsAndConditions 
$ curl -X GET ${baseUrl}/xapi/v1/portals/{targetOrganizationId}/{targetPortalId}/assets/{groupId}/{assetId}/{minorVersion}/terms \
  -H "Authorization: Bearer ${authToken}" \
  -H "Content-Type: application/json"
Captured Variables
termsContent $.content

Step 5: Fetch Documentation Pages

Each asset can publish multiple documentation pages (home, guides, changelog, etc.).

api-experience-hub-consumer.getAssetPages 
$ curl -X GET ${baseUrl}/xapi/v1/portals/{targetOrganizationId}/{targetPortalId}/assets/{groupId}/{assetId}/{minorVersion}/pages/** \
  -H "Authorization: Bearer ${authToken}" \
  -H "Content-Type: application/json"
Captured Variables
pageContent $

Step 6: Fetch Asset Resources (Optional)

Download companion resources (diagrams, sample files, SDK bundles) attached to an asset.

api-experience-hub-consumer.getAssetResource 
$ curl -X GET ${baseUrl}/xapi/v1/portals/{targetOrganizationId}/{targetPortalId}/assets/{groupId}/{assetId}/{minorVersion}/resources/{resourceId} \
  -H "Authorization: Bearer ${authToken}" \
  -H "Content-Type: application/json"
Captured Variables
resourceContent $

Completion Checklist

  • [ ] Portal catalog browsed or searched
  • [ ] Candidate asset identified
  • [ ] Full asset details reviewed
  • [ ] Terms and conditions read
  • [ ] Documentation pages consulted
  • [ ] Companion resources downloaded (if applicable)

What You've Built

✅ Informed API Choice — You have the metadata, terms and docs you need to decide which API to request access to.

Next Steps

  1. Request access — See request-api-access to create a contract against the chosen instance and tier.
  2. Manage your applications — See manage-portal-applications to create the application identity that will consume the API.