Integrate DigiFi's API to connect your other systems with DigiFi's platform

Overview

DigiFi's API is organized around REST and uses built-in HTTP features, standard response codes, authentication and verbs, allowing for quick implementation with standard HTTP packages used in all languages. The API accepts requests with a JSON body and returns JSON responses.


Authentication

Your organization's API credentials can be viewed and managed by navigating to Company Settings > Developers > DigiFi API Keys within DigiFi's platform.

To authenticate a request, you must include your client_id and client_secret in the request header for all requests (POST, PUT, GET and DELETE).

Key

Type

Required/Optional

Description

client_id

String

Required

Identifier specific to your organization

client_secret

String

Required

One of two secrets assigned to your organization


Response Status Codes

DigiFi's API uses conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 200 range indicate success, codes in the 400 range indicate an error with the request and codes in the 500 range indicate an error with the server.

Status Code

Status Message

Description

200

Success

The request processed successfully

400

Bad request

The request was incorrectly formed

401

Unauthorized

The authentication credentials were incorrect

404

Resource not found

The requested resource cannot be found

500

Internal server error

There was an error on the server