Pulsoid API Documentation
DashboardRequest CredentialsDiscord
  • Intro
  • Access Token Management
    • OAuth2 Implicit Grant
    • OAuth2 Authorization Code Grant
    • OAuth2 Client Credentials Grant Type(server token)
    • Manual Token Issuing
    • OAuth2 Refreshing the token
    • Revoke authorization token
    • Validate authorization token
    • List of supported scopes
  • Read Heart Rate
    • Read Latest Heart Rate via HTTP
    • Read Heart Rate via WebSocket
    • Page
    • Read Statistics
  • Widgets Management
    • Widget Entity
    • Create Widget
    • Read Widget
    • Update Widget
  • Read Profile Information
  • Error Code Format
  • VRChat
    • VRChat World Integration
Powered by GitBook
On this page

Intro

NextAccess Token Management

Last updated 1 year ago

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 . 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 to help you :).

How to obtain an authorization token

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

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

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

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

  • If you are developing a plugin or desktop application, then 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 support@pulsoid.net or .

Recap

So, to integrate with Pulsoid you need to:

  1. Request client credentials via

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

  3. Use the API

FAQ

form
here
Manual Token Issuing
Implicit Grant
Implicit Grant
Authorization Code Grant
Discord
form
Implicit Grant with response_type=web_page