Skip to main content

Getting Started

The Pulsifi Developer API allows developers to access a collection of resources from Pulsifi. The API make it possible for partners to integrate with Pulsifi and bring some of the most used features into their own systems.

To get started with the Staging environment, please reach out to your Pulsifi account manager handling the integration project.

Overview: The Pulsifi Developers API​

The Pulsifi Developers API is built on REST principles, offering predictable resource-oriented URLs, JSON-encoded responses, and standard HTTP response codes. Whether you're a seasoned developer or just starting out, our API provides the flexibility and scalability you need to meet your integration requirements.

Pulsifi API Base URL​

Production
https://api.pulsifi.me
Staging
https://staging.api.pulsifi.me

Status and error codes​

All queries to the API return standard HTTP status codes that can tell you more about the response, including the success or failure of the API request.

In general, status codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was missing, you do not have adequate permissions, etc.). Codes in the 5xx range indicate an error with Pulsifi servers which is rare.

Standard HTTP status codes:​

  • 200 - OK: Everything worked as expected.
  • 400 - BAD REQUEST: The request was unacceptable, eg. due to missing a required parameter.
  • 401 - UNAUTHORIZED: The access token provided is not valid.
  • 403 - FORBIDDEN: The access token does not have permissions to perform the request.
  • 404 - NOT FOUND: The requested resource was not found.
  • 409 - CONFLICT: The request conflicts with an existing resource.
  • 429 - TOO MANY REQUESTS: Rate limit exceeded. Too many requests hit the API too quickly.
  • 500 - INTERNAL SERVER ERROR: Something went wrong on Pulsifi's end. (Rare)