User Manual
  • WELCOME
  • QUICK START
    • Publish a service
    • Consume a service
  • Step by step
    • Manage your User Account
      • Signup / Login
      • Edit your Profile
      • Change your Password
      • Reset your Password
    • Manage your Workspace
      • Create a Workspace
      • Edit Workspace Details
      • Manage Users
    • Provide a Service
      • APIs
      • Service Configuration
      • Adding Plans
      • Preview & Publish
        • Preview
        • Submit
      • Subscription approval
    • Subscribe and Consume a Service
      • Subscribing to a Service
      • Consumer Clients
      • Consuming an API (technical Implementation)
  • CONCEPTS
    • Visibility in the Catalog
    • Services without APIs
    • Authorization
  • RESOURCES
    • Get help
    • apinity.io
    • apinity-xplore.io
  • Release Notes
    • About the release notes
    • 2024 July
    • 2024 June
    • 2024 May
    • 2024 April
    • 2024 March
    • 2024 February
    • 2024 January
    • 2023 November
    • 2023 October
Powered by GitBook
On this page

Was this helpful?

  1. CONCEPTS

Visibility in the Catalog

Last updated 6 months ago

Was this helpful?

You have several options to determine the visibility of your service, and of individual plans. This article explains these settings, and gives you a checklist to help your service appear publicly in the .

Service Visibility toggle This toggle on each Service card under Services, defines globally whether the service can appear in the Catalog. If switched off, the service is accessible only via direct link. Anyone with the link can access the service page, this toggle does not involve any permissioning. For more info, see .

Plan Permissions On individual Plans, you can define who is allowed to see them (and hence, subscribe). You can use "Selected Workspaces" for test plans (limiting to your workspace), or to offer tailored pricing, limits, or even custom API backend, to specific customers.

"All Workspaces" will display the plan in the public catalog. For more info, see .

Plan Visibility You can additionally toggle the visibility of individual Plans. This can be used to retire plans without ending the existing subscriptions.

Hidden plans will not appear to anyone (irrespective of permissions), and cannot be subscribed to.

Visible plans will adhere to the permissions set in the previous step.

In order to appear in the public catalog

  • a Service must be set to Visible, and

  • at least one Plan - must be set to Visible, and - must be permissioned to All Workspaces.

Catalog
Add a Service
Add a Plan