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
For Personal Use: Manual Token Issuing is suitable and client credentials are not needed.
For Websites: The Implicit Grant is suitable.
For Desktop Applications: If handling deep links, the Implicit Grant is suitable.
For Backend Servers: The Authorization Code Grant is recommended.
For Plugins or Desktop Applications: Use OAuth 2 Device Authorization Flow.
For Plugins or Desktop Applications: In case OAuth 2 Device Authorization Flow is not suitable for you use Implicit Grant with
response_type=web_page.For Enterprise Applications: To use Pulsoid for real-time heart rate data, contact us at [email protected] or on Discord.
Recap
So, to integrate with Pulsoid you need to:
Request client credentials via form
Decide, what way of obtaining tokens is suitable for you
Use the API
FAQ
Last updated