Skip to main content

Authentication

POST
/partner/v1.0/partner/oauth2/token

Authentication is the process of verifying the identity of the user or the app interacting with the Pulsifi platform. Authentication is required to keep interactions with Pulsifi safe and secure, all apps connecting with the Pulsifi APIs must authenticate.

Pulsifi uses OAuth 2.0, an industry-standard framework, for authentication. OAuth enables developers to make authorized requests to the Pulsifi API on behalf of a user. This is achieved by establishing an authentication flow, that is used to obtain an access token. The access token serves as permission to act as a user and must be included in the Authorization header of each API request.


Requirements​

Contact us if you need to set up an account. We will provide you with the client_id and client_secret.

For assistance with setting up an account, feel free to reach out to us at support@pulsifi.me


Base64 encoding​

Use Base64 encoding for your client ID and client secret in the format client_id:client_secret.
Tools like base64encode.org can help with this.


Headers​

  • Accept : application/json
  • Content-Type : application/json
  • Authorization : Basic {ENCODED_CLIENT_ID_AND_CLIENT_SECRET}

Body​

grant_type enum Required
The type of OAuth 2.0 grant
  • client_credentials


Response​

200 OK.

Parameters
access_token string
The token that must be included in the `Authorization` header of all subsequent API requests.
scope string
The permissions granted to the access token, defining what actions or resources it can access.
expires_in string
The lifetime of the access token in seconds.
token_type string
The type of the token, usually `bearer`, indicating how the token should be included in API requests.
POST /partner/v1.0/standard/jobs/:job_id
  curl --request POST 'https://api.pulsifi.me/partner/oauth2/token' \
  --header 'Accept: application/json' \
  --header 'Authorization: Basic YOUR-ENCODED-CLIENT-ID-CLIENT-SECRET' \
  --header 'Content-Type: application/json' \
  --data-raw '{"grant_type": "client_credentials"}'
Response
{
  "access_token": "string",
  "scope": "string",
  "expires_in": "string",
  "token_type": "bearer"
}