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
  • Quick Start
  • Overview

Was this helpful?

  1. Step by step

Subscribe and Consume a Service

Last updated 8 months ago

Was this helpful?

Quick Start

For a brief overview check out

Overview

Definition: Subscriptions are the contractual and technical relationship between a Consumer and a Provider. By subscribing to a service the consumer enters a relationship with the providers which is defined by the details of the plan and the service.

Subscriptions are the central entity for consuming services on the marketplace. The subscription (and its unique ID) represent one relationship between a provider and a consumer.

Technical integration: For each subscription, there is a unique technical ID and Base URL on the marketplace. This means, the technical integration will always remain the same, even if commercial aspects of the contract change.

Consumer clients: Consumers can manage access to their subscriptions via consumer clients. These are separately defined authentication keys that can be freely assigned/unassigned to subscriptions. One or more consumer clients can be assigned to one subscription, e.g. for granting access to the same service for individual teams or different applications. One consumer client can also be assigned to multiple subscriptions.

Plans: Plans determine the technical and commercial aspects of a service. Different plans can have different prices, limits or transactions. When subscribing, the consuming partner can chose the best fitting plan. The plan can be changed later without breaking the integration if both, provider and consumer agree.

Consume a Service - quick overview
click image to enlarge