Quick Start

Consume APIs in 5 minutes.

Starting with myAPIz Platform is easy. Just sign in with your Google account or your Github account and you're ready to go.

By signing in you will be able to access both consumer and provider features.

Create a Client App

A Client App represents an application runtime that consumes a set of APIs.

For example, let's say we need to configure a web app that interacts with the Time base One Time Password to generate some unique codes.

Navigate to Consumer -> Apps page and click "Add Application". In the opened dialog, under application details, enter a name and description.

API Access section you need to list the APIs that this app will consume and what permissions it needs.

Applying the principle of least privilege, we can limit the permissions for this Client App to be only Sheet with Execute and Read permissions.

Now in the credentials section, we define how the client app will authenticate with the specified group of APIs.

The dialog will automatically create a Key based authentication credentials for us. Click the copy button to take the credentials since we are going to need them later.

Finally, press "Create" to complete the creation of the Client App.

You will see the client app in your Consumer -> Apps list.

Integrate in your App

Now that we have a Client App, we can integrate it in our app.

First we need to look at the documentation for this Client App. Click on the "Documentation" link to open the API documentation for this Client App. This will open reference documentation only for the APIs used in the client app.

You can review the Time-based One-time Password API and understand how to use it.

In this example, we are going to use the "/totp/id POST" endpoint in order to generate a code.

Change the client to Python Request in the documentation example and copy paste the code in your script. The example shows you also what to expect as a response.

This is it. You can now use the Time-based One-time Password API in your app. Notice that when add other APIs to your Client App, you can keep using the same Python client since the credentials are the same.

Setting up your account

You can also create an organisation where you can invite team members.

To start with, you can stick with your personal organisation. But once you start building a production setup, you need to create organisation relevant to your business structure.

Down at the bottom right you have access to your Profile settings for further user settings.