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
  • Finding a Service
  • Viewing Details of a Service
  • Ordering a Subscription
  • Setting up your Consumer Clients
  • Managing your Subscription
  • Using the APIs

Was this helpful?

  1. Step by step
  2. Subscribe and Consume a Service

Subscribing to a Service

Last updated 8 months ago

Was this helpful?

For a brief overview check out


Finding a Service

Navigating to brings you to the marketplace Catalog.

You can either browse through the listed Services, use the search bar to look for a specific Service, or filter by category or country using the dropdowns.\

Viewing Details of a Service

Clicking on a Service leads you to the service's Overview and Available Plans sections.

  • Overview - this page contains the service description and feature details.

  • Available Plans - this page contains an overview of all the available plans as well their respective Limits & Pricing, Documentation & Contract, and Swagger File.

Ordering a Subscription

Once you have decided on the service and plan you want to subscribe to, click Subscribe in the Available Plans section of the service.

Click Complete Order to agree to the terms and data policy, and to subscribe.

Setting up your Consumer Clients

After you completed a subscription, you will find the service under the Subscriptions section of My Hub. In order to consume the service, you must assign at least one Consumer Client. Under the Technical Setup of the service, you have the option to create a new consumer client, or assign an existing one.

If you have already set up Consumer Clients, you can choose Assign/Unassign Clients and select one or more of these.

If you need a new consumer client, you can choose Create New & Assign, or freely create new unassigned consumer clients under the Consumer Clients section of My Hub, by clicking Create New Client. Both will lead you to a similar dialogue window:

Make sure to save the API Key or Client Secret in a secure place as long as it is visible. Once you click on Create Client, you will no longer be able to view this API Key or Client Secret, and will have to generate a new one.

Managing your Subscription

Once your subscription is active, you can click on it in the Subscriptions section to view the details of the subscription. Technical and business-related information is shown in separate tabs:

  • Technical Setup (only for API services) - contains the Endpoint URL, consumer client settings, Swagger documentation, and additional technical documentation if provided.

  • Business Setup - contains the plan, subscription period, pricing and contract. You can also unsubscribe from the service here.

Using the APIs

On the next page, you can review your order, as well as read the , the Terms of Service of the Service Provider, and the

If this is your first time setting up a consumer client, please check the article for more information.

You can choose between a simple API key and OAuth for authentication. You can read more about these in the article.

With everything in place, you can now start consuming your subscribed Services. For more information, please see the article.

apinity marketplace Terms of Service
Data Policy
Consumer Clients
Consumer Clients
Consume an API (technical Implementation)
Consume a Service - quick overview
https://marketplace.apinity.io/