The impact.com API is organized around REST. Our API has predictable, resource-oriented URLs, accepts form-ended or JSON-encoded request bodies, returns XML-encoded or JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
To use the API, you will first need to enable API access, the retrieve your API credentials (Account SID and Auth Token) when they appear on the API Access screen. To reach this screen, follow the steps below:
From the left navigation bar, select [Cloud] → API.
What you plan to do via API will affect which set of credentials you retrieve.
If you want to do anything beyond retrieving information (like creating action inquiries), you should receive the Account SID and the Auth Token.
If you only want to retrieve information from impact.com via API, you should retrieve the Read-Only Account SID and Read-Only Auth Token.
We have provided a list of IP address ranges that you will need to allowlist. Ensure that you allowlist the entire range, as you may accidentally be preventing impact.com's API from communicating with your system if you do not.
You have access to more resources compared to FTP and postbacks.
You can POST and PUT data into impact.com's system that is unrelated to actions or action inquiries (e.g., updating your media properties).
You have access to all developer documentation of the impact.com API.
To log in, use the same username and password as you use to log into the impact.com web app.
You are subject to rate limits if you attempt to make more than 1000 requests per hour.
You will have to make a call to our API to discover if/when any actions were tracked, modified, or reversed as well as to discover if any action inquiries you created are resolved.
You must have your own system set up that can communicate with impact.com's API.
If you want your responses to return in JSON format, include the header
Accept: application/jsonin your calls.
Set up your API system to dynamically throttle requests to impact.com as you approach your rate limit (which is set to 1000 requests per hour).
If you need constant updates on actions you drive or action inquiries you create, use impact.com's postback system (discussed above).
To get the same information that action lifecycle postbacks and action inquiry postbacks would send you, use the actions and action updates endpoints (for action lifecycle information) as well as the action inquiries (for action inquiry information).