Getting started

API Suite is a self-service Portal service that is rich in features, scalable and focused. You can consider API Suite as the public-facing tip of the “digital iceberg”, and that’s exactly what we focus on.

We connect with the underlying layer of API gateways, clusters and service meshes built by other specialists.

To understand how API Suite works:

  • Understand the idea behind a [self-service portal]

  • Read up on the concept of [extending the core application]

  • See which [licensing model] fits your organisation best

--

To help you get started, check out the rest of the documentation in this wiki:

https://cloudoki.atlassian.net/wiki/spaces/APIEC/pages/573112374 https://cloudoki.atlassian.net/wiki/spaces/APIEC/pages/573931546 https://cloudoki.atlassian.net/wiki/spaces/APIEC/pages/573440045

 


For Marketplace users

If you are using the Marketplace for the first time, you might want to familiarise yourself with the features before sharing your personal information.

Start here:

API Suite docs for Developers

The API Suite Portal offers developers and Third-Party integration managers a rich set of services and features.

To get yourself familiar with the Portal, start here:

API Suite docs for Account Owners

Our documentation helps you get the most out of your API Suite account. It covers all you need to know to manage your API and integrations ecosystem.

To start, you might want to:


Extended version

API Suite unlocks your APIs and service integration capabilities within your product ecosystem. To discover the added values for your API tech team and business team alike, we’ll guide you through the required steps to getting things done.

We go more in-depth in [API Suite explained]

API Suite in your stack

API Suite lives on the “edge“ of your product ecosystem from a technical point of view, just like your web platform or mobile product app. The API Portal and Marketplace are different representations of the data already being made available to your user, with the same “KYC” (Know Your Customer, e.g. OpenID), augmented by a series of additional features that come from the API Suite service.

In other words, API Suite lives stand-alone within your product ecosystem, instead of having to direct your users away to an external platform or having to implement intrusive code in your product core by your tech team.

To allow your tech and business team to operate asynchronously, we promote the interfacing of your data through a “Gateway“ and the identification of your product users through an “Identity Provider” (OIDC). API Suite anchors the third leg in this industry-standard configuration, strengthening the “security by design” case for the tech team.

API Suite strives to support all common Gateway and OIDC providers (including multiple free and open-source products) to mitigate any vendor lock-in.

 

[API 101: How to make beautiful APIs]

 

Register account

To sign up for API Suite cloud , simply click the Sign-up button on the website. The registration process of your API Suite account only takes a minute.

  1. Activate your

core API Suite Core provides an easy “[3-minute guide]“ on how to set up a local version of API Suite.

 

 

  1. Connect your ecosystem

  2. Unlock your SaaS potential

Why APIs and integrations

Define business cases

Register account

API Suite in your stack

Connect your ecosystem

Unlock your SaaS potential

 

 

API Suite is a self-service Portal service that is rich in features, scalable and focused. You can consider API Suite as the public-facing tip of the “digital iceberg”, and that’s exactly what we focus on.

We connect with the underlying layer of API gateways, clusters and service meshes built by other specialists.

To understand how API Suite works:

  • Understand the idea behind a [self-service portal]

  • Read up on the concept of [extending the core application]

  • See which [licensing model] fits your organisation best

--

To help you get started, check out the rest of the documentation in this wiki:

https://cloudoki.atlassian.net/wiki/spaces/APIEC/pages/573112374 https://cloudoki.atlassian.net/wiki/spaces/APIEC/pages/573931546 https://cloudoki.atlassian.net/wiki/spaces/APIEC/pages/573440045


Note the https://github.com/APISuite/apisuite-be/issues , which lists any bugs we know about, but where a fix is yet to be deployed.

We are always available to assist you personally https://intercom.help/api-suite/en