Getting Started

This guide will get you started using our API.

Create an Account

The first step is to create an account, this can be done via our website or via the API.

The following endpoints will be useful for creating a user, and then connecting them to presence management feature.

Create a user

info

Creating an account via the API requires an access token, see Authentication for more information. You will need to have a valid account first before you can create users.

Using the API

Once you have a user account, you can use the API to create a business and manage your presence.

Authentication

See Authentication for more information on obtaining an access token.

Making Requests

Some good endpoints to check if you were successful so far are:

Get current user

Get users businesses

Get active user

All you need to do is attach the token in the Authorization: Bearer <token> header.

Create a Business

Once you have a user you will likely want to create a business, set additional fields on it. This could also be a good time to connect the user and business to the presence and review management features.

Create a business

Create an open period for a business

Create a special open period for a business

Connect User to RPM.

Connect given business to RPM.

Frontend SDK

You can embed any part of our frontend into your application, using the users access token or via our login page. See Frontend SDK for more information on how to embed the Frontend SDK into your application.