Ingestion API

Authentication

The Leapfin API is organized around REST. Our API uses HTTP response codes to indicate API errors.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Base URL:

https://api.leapfin.com/v1/data/

You will be provided a Secret API Key by Leapfin accessible on the integrations page in your Leapfin account. Please remember you should never expose your secret API key in any public website's client-side code. We expect the API key to be included in all API requests to the server in the Header as follows:

X-Api-Key: a1b2c3d4e5f6

All requests should be submitted with a content-type application/json:

Content-Type: application/json

Example Request:

curl https://api.leapfin.com/v1/data/objectType \
    -H "X-Api-Key: a1b2c3d4e5f6"

📘

You must replace a1b2c3d4e5f6 with your personal API key found on the integrations page in your Leapfin account.

Limitations

  • Do not send more than 1000 objects in any request.
  • Do not simultaneously submit more than one request.

Data Ingestion

Object Type

The request body must be a non-empty JSON array of objects, where each object has a unique unique_id. The unique_id field and the [object_type] name in the request will be determined with the Leapfin Implementation Team during the onboarding process. In cases where the object already exists in our system, the default behavior is to update the existing data.

HTTP Request

POST https://api.leapfin.com/v1/data/[object_type]

Object Properties

Property

Required

Description

unique_id

Yes

External ID

curl https://api.leapfin.com/v1/data/[object_type]
  -H "X-Api-Key: a1b2c3d4e5f6" 
  -H "Content-Type: application/json"
  -X POST
  --data 
  '[
    {
      "unique_id": "test",
      "amount": 12345,
      "date": "2018-01-01"
    },
    {
      "unique_id": "test",
      "amount": 12345,
      "date": "2018-01-01"
    }
  ]'