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
  • Create a new service
  • Catalog card
  • Service details
  • Plans
  • Optional details

Was this helpful?

  1. Step by step
  2. Provide a Service

Service Configuration

A service is the marketing representation of a product and its features.

Last updated 6 months ago

Was this helpful?

Create a new service

In My Hub, click Add Service in the top-right. In the subsequent popup, enter a Service Name and click Add Service.

The steps of creating the service and a plan is shown in the left side menu. Catalog card, Service details, and Plans are mandatory. The rest of the details are optional.

At the top of the screen, you find the Service Configuration toolbar, where you can Save as draft anytime and return to edit the details, before you proceed to Publish a service.

Catalog card

In this section, you can design the tile that will appear in the Catalog for consumers. A live preview is shown on the right side.

Service details

In this section, you can design the service page that opens when someone clicks on the Catalog card.

This includes

  • visual settings of the page header

  • a selection of supported countries (optional, the default is all countries)

  • detailed description (a longer text describing your service)

  • product images (optional, any images, screenshots, etc you want to show)

A live preview is shown on the right side.

Plans

Optional details

Optionally, you can add further details to your service, such as Security & Compliance certifications, customer References, Technical documentation, FAQs, and Contact details specific to the service.

After a service is published, editing the service details is disabled.

Only the Plans section remains editable for published services.

For each step, a checkmark indicates if all mandatory fields are filled out. Once these fields are completed for the mandatory steps, the service can be submitted for publishing.

To publish a service, you need to create at least one Plan. Please refer to the next article for details.

Adding Plans