Intro

Welcome to the Pulsoid API documentation.

Pulsoid enables real-time heart rate data transmission from the peripherals(like BLE heart rate monitors, smartwatches, etc) to the Clients. Pulsoid API allows reading real-time heart rate data.

Users - are real people who stream their heart rate data via Pulsoid.

Clients - are applications that want to read Pulsoid users' data. The developer should request client credentials via the form. Received client credentials include client_secret which should be stored securely and never shared.

To consumer Pulsoid API, the developer should obtain an authorization token. An authorization token is used in every API call. Obtaining the token can be challenging but we are here to help you :).

How to obtain an authorization token

• If you are developing for yourself, then Manual Token Issuing is suitable for you, and client credentials are not needed.

• If you have a website, then Implicit Grant is suitable for you.

• If you are developing a desktop application that is able to handle deep links, then Implicit Grant is suitable for you.

• If you have a backend server, then Authorization Code Grant is suitable for you.

• If you are developing a plugin or desktop application, then Implicit Grant with response_type=web_page is suitable for you.

• If you are developing an enterprise application and want to use Pulsoid as a platform for obtaining real-time heart rate from your customers, then contact us at [e-mail] or Discord.

Recap

So, to integrate with Pulsoid you need to:

1. Request client credentials via form

2. Decide, what way of obtaining tokens is suitable for you

3. Use the API

FAQ