Skip to main content

Subscribe to an API

Choose a plan​

First of all, you need to choose an API to subscribe. In the information page of the API, select the Plans tab. Here are presented the different pricing plans of the API (if team decides to present multiple plans). Just click the subscribe button. If you are member of several teams, please choose teams to make subscription and click the subscribe button.

If the plan has no process of subscription, a green message appears to inform you that the subscription is successful. Otherwise, the process is followed step by step until the subscription is generated (it could take a few moment).

Payment Process​

When a user reaches the payment step in the subscription process, Daikoku facilitates the transition to the payment gateway to collect payment information and process the transaction. Here's how it works:

1.** Redirect to the checkout page**: The user is automatically redirected to a secure payment page, where they can enter their payment information, such as credit card details.

  1. Payment Information Handling: Daikoku does not store user payment information. All payment details are collected directly by the payment gateway, ensuring the security of sensitive data.

  2. Transaction Processing: The payment gateway processes the transaction using the payment information provided by the user. Once the transaction is successfully validated, Daikoku receives a payment confirmation notification.

  3. Subscription Validation: After payment validation, Daikoku marks the subscription as approved in the system. The user is then redirected to the Daikoku homepage, where they can start using the subscribed API features.

If a user has already subscribed via the payment gateway, his team and information will be retrieved because they are associated with their Daikoku IDs.

Fast mode​

Daikoku offers a fast mode to display, for a selected team, only accessible APIs (and subscriptions plans with their informations). In this UI, you can subscribe to all plan without switching pages and get subscription credentials.

Deprecated and blocked APIs​

An API you rely on can change state over time (see the producer guide, Managing the API lifecycle):

  • Deprecated — the API still works and stays subscribable, but the producer signals it is on its way out. You are asked to confirm before subscribing to a deprecated API, and teams that already subscribed receive a deprecation notification and email. Plan your migration.
  • Blocked — the producer has suspended the API: it disappears from the catalog, its page returns an error, and the API keys derived from your subscriptions stop working. Your subscriptions are not deleted, so access is restored if the producer unblocks the API. Impacted teams are notified.

A producer can also block a single subscription without blocking the whole API — in that case only that subscription's key is cut.