Open API Portal with Public API

To lower the adoption barrier for your developer community, Public API enables you to expose non-business critical APIs and their methods so that your API consumers can access them without creating a user account or logging in. This way you can offer a teaser to your audience while still keeping the more sensitive information secure.

When Public API is enabled, users can browse the APIs and applications you have specifically exposed for public access. Instead of asking the user to authenticate, API Portal uses a specific user account to access API Manager under the hood. The sign-in link is visible in the API Portal main menu, so users can still sign in or sign up to API Portal to use all the features.

API Portal administrator can enable and disable this feature in the Joomla! Administrator Interface (JAI). The exposed APIs and applications are configured in API Manager. For more details, see Configure Public API.

Differences in user experience

The user experience in public API Portal is different than when signed in:

  • On the API Portal landing page, the Sign In button is replaced with an Explore button that goes to API Catalog.
  • The items in the main navigation menu have the following changes:
    • API Catalog displays only the APIs and methods configured to be exposed in Public API, but is available normally.
    • The Applications page is available as read-only, and the Usage tab is disabled.
    • The Monitoring and Users pages are unavailable.
  • The user profile information is unavailable.

Public API only affects your APIs and applications. Joomla! articles, blogs or forums are not included in Public API. You can manage how these are exposed by changing their Access settings in JAI.

Related Links