Difference between revisions of "Getting Started with the API"

From Email Marketing Wiki
Jump to: navigation, search
Line 27: Line 27:
 
To reset your API key (for example, in the event that it has been compromised), just click the “Reset” button next to the Key field:
 
To reset your API key (for example, in the event that it has been compromised), just click the “Reset” button next to the Key field:
 
<br/><br/>
 
<br/><br/>
[[file:API_Screen4.jpeg]]
+
[[file:API_Screen4.png]]
 
<br/><br/>
 
<br/><br/>
 
Confirm that you want to reset it:
 
Confirm that you want to reset it:
 
<br/><br/>
 
<br/><br/>
[[file:API_Screen5.jpeg]]
+
[[file:API_Screen5.png]]
 
<br/><br/>
 
<br/><br/>
 
The API Key field will then flash blue to indicate that the key was changed:
 
The API Key field will then flash blue to indicate that the key was changed:
 
<br/><br/>
 
<br/><br/>
[[file:API_Screen6.jpeg]]
+
[[file:API_Screen6.png]]
 
<br/><br/>
 
<br/><br/>
 
'''Please note:''' once you reset your API key, all access will be denied until you update your applications to use the new key.
 
'''Please note:''' once you reset your API key, all access will be denied until you update your applications to use the new key.

Revision as of 11:38, 30 April 2013

The systems API integration is recommended for any functionality needed outside of the main user interface. We provide a list of available API methods along with detailed descriptions of each parameter, as well as examples in actual code. What follows are general instructions of how to get started using the API. This will not delve into actual code examples or implementation specifics – for that, please visit the API resources section.

Overview

The API is a REST implementation, and requires authentication (actual user account within the software, or valid API URL and key).

General Requirements

Valid ActiveCampaign account (a trial account will also work fine). Familiarity with programming concepts and practices. Ability to submit HTTP requests from your server.

Obtain API URL and Key

The first thing you will want to do is obtain your API URL and Key.

Email Marketing users can simply visit the “Your Settings” section of the software:

API Screen1.jpeg

API Screen3.jpeg

Once you obtain these values, you can submit API requests by looking at our examples page to see what parameters are required, and how they should be formatted.

Reset Your API Key

To reset your API key (for example, in the event that it has been compromised), just click the “Reset” button next to the Key field:

API Screen4.png

Confirm that you want to reset it:

API Screen5.png

The API Key field will then flash blue to indicate that the key was changed:

API Screen6.png

Please note: once you reset your API key, all access will be denied until you update your applications to use the new key.