- Overview
- Generating an API Token
- Using the Open API
- Using the Subscription API
- Retrieving Lead Field IDs
Overview
The Open API provides the ability to access or update your CRM data using REST calls.
The following APIs are available:
Generating an API Token
Your API requests must include an API token to authenticate your account.
Tokens are generated individually by each CRM user. A user can create multiple tokens if needed.
To generate a new API token, open your user settings page by clicking your username in the top-right corner and selecting Settings.
On the user settings page, open the API Settings tab and click Create New API Token.
In the popup window, enter a name for your token, optionally add IP restrictions, and click Add New Token:
Your new token will be generated and displayed in a popup window (along with your public key if needed):
After creation, the token appears in the list of available API tokens. From this list you can copy the token, update its settings, or delete it when it is no longer required:
☝️ Created tokens inherit the user's permissions for assigned merchants, leads, groups, and processors. API tokens should not be shared in publicly accessible locations or used in client-side code.
Using the Open API
To access the API documentation on your CRM instance, enter the following URL in your browser and replace yourdomain with your actual domain: https://yourdomain.iriscrm.com/api/
Authentication is performed through the X-API-KEY request header. Requests that are not properly authenticated will return a 401 error code.
All requests should be sent over SSL. Request and response payloads, including errors, are encoded in JSON format.
The API returns standard HTTP success and error status codes. When an error occurs, additional details are included in the JSON response.
By default, the API allows up to 120 requests per minute. You can check the HTTP headers returned by each API request to see your current rate limit status.
Using the Subscription API
API subscriptions allow you to send event-based information to a specified URL and automatically trigger an API call. This approach is generally more efficient than running scheduled API requests.
To create a subscription through the Open API, send a request following the instructions in the Subscriptions section.
You only need to specify the events you want to subscribe to and the URL where the updates should be delivered.
Subscriptions can also be created directly in the CRM from the API Settings tab on your User Settings page:
Retrieving Lead Field IDs
The Lead API is commonly used to update or retrieve values from specific lead fields.
To interact with a lead field using the API, you must know the field’s ID. You can find the field ID on the lead field management page:
Manage → Leads → Manage Lead Fields → Add/Remove Fields
You can also retrieve all lead field IDs using the /leads/fields GET request: