An API key is a token that you provide when making API calls.

An Application ID that finds the application you are working with. This
Application ID can be found on the Integral platform through the dashboard or
Application’s page.

Request

Response

Contact Us

Demo

Integral

Request Demo

Contact Support

This request is used to fetch all the Tiers allowed to be assigned to a user, before creating one. Call this endpoint before creating an Application User

Get All Application Tiers

Integral is making the ability to build external APIs incredibly easy, by taking care of the logic necessary to initially build and maintain external APIs, but still allowing full flexibility over their API and how it interacts with their system.

Introduction to Integral

Get an idea of whether your needs fit what Integral can solve easily and in a much more robust manner by going through this page. We highly recommend you use this page as a reference for your public API needs.

Should You Use Integral?

This page is where you should start to get a sense of what it looks like to get your API up and running with Integral. By the end of reading (or skimming as most of us do), you'll have a good sense of Integral and how to use it

Quick Start

Node.js + Javascript example of how to use Integral

Implementation

This endpoint should be put in the pre-processing middleware:  Authentication, Access Control, Dynamic Rate Limiting, Idempotency, Versioning, Sandbox, and more.

Pre-process your API Request

This endpoint is a follow up to the /pre-process endpoint

Post-process your API Request

Use this endpoint to create an application user. With an application user, you define an 'API key owner' that holds top level information  that is constant for all API keys made for a user

Create an Application User

This endpoint takes in an Application User's ID and returns back relevant information regarding the user, and it's tier

Get an Application User

This endpoint is used to generate an API key for a given user. This API key is for the Application User it is assigned for only, and only for your API.

Generate an API key

Retrieve all production API keys for the given Application User

Get Application User's Production API Keys

Retrieve all sandbox API keys for the given Application User

Get Application User's Sandbox API Keys

Given an API Key generated for your application's user, this endpoint allows you to pause the API key.

Pause an API Key

Given an API Key generated for your application's user, this endpoint allows you to revoke the API key.

Revoke an API Key

Given an API Key generated for your application's user, this endpoint allows you to unpause an already paused API key.

Unpause an API Key

Use this endpoint to get the logs for a given application, or for a given application user

Retrieve Application Logs

Integral will not make a backwards incompatible change on an existing version, but will often make backwards compatible changes.

Backwards-Compatibility

We know how confusing documentation can get with all of its terms and nuances, so hopefully we have this page to simplify that. If you want us to add more terms, please contact us!

Get Started

Parse

Application User

API Keys

Tiers

Logs

Extras

Get All Application Tiers

Request

Response

Get Started

Parse

Application User

API Keys

Tiers

Logs

Extras

​Request

​Response

Request

Response