Quick Start
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
Integral: A Public API in Minutes
To set up:
For a white glove set up and onboarding, send a short email to shrey@integralapi.co and we’ll get the process started. We are happy to help in any way, from adding all the endpoints and tiers, to writing the code or helping to debug it as well.
- Set up your application’s information on Integral’s portal
- Head over to Integral’s portal
- Create an account, an organization, and add an application
- Within this application, configure anything you’d like with your API:
- You can manage which endpoints, tiers, rate limits, etc – configure anything you want to expose and how you want to expose them
-
Implement the /parse/pre-process endpoint in your public API’s pre-processing middleware
- This endpoint is necessary to build and maintain all of your public API’s middleware.
-
Allows users to use Integral to
- Create their Application User
- Manage their API keys.
You can do this by setting up Integral’s Application User and API Key management API, or you can edit or add to this information manually using Integral’s portal
-
Deploy your public API on a cloud hosting service (or in house) if you’d like.