Get Started
Incentify offers enterprise customers a RESTful web service which accepts, processes and responds with data in JSON format. An active account with an active API Key will allow you to interact with this API.
Incentify expands its API docs based on common needs of our enterprise customers. If you require additional endpoints to achieve your desired integration, please visit our Help page to submit a request at any time. Thank you!
Requirements
The following is required to interact with the Incentify API:
- An active Incentify Account (Sandbox and Production)
- API Access included in pricing plan
- Active Incentify API Key
Get Prepared
Incentify offers a Sandbox environment for testing API integrations before switching to Production API keys. Upon integration kick off Incentify will configure a Sandbox account to mirror your Production account and provide Sandbox API keys. Once satisfied with youre integration, you may switch to using your Production API key.
- Get Environment Details: API Environments
- Get an API Key: Authorization
- Get familiar with the Incentify Data Architecture
- If you are creating/updating data on Incentify please familiarize yourself with User Access rules
Next Steps
We recommend you get started with one of the Guides based on your use case. Here's a few recommended starting points:
- Pulling Incentify data into a BI Dashboard? Check out this: Guide
- Synching Accounts, Users and Portfolio data? Start with this: Guide
Or you can go directly to the Resources, a common place to start is: Project Resource (endpoint).