API Keys: How Do I Generate and Use API Keys?

Last Updated: Oct 26 2017 12:58 pm UTC

If you are a programmer or a web developer, we provide API keys to enable integration between our platforms features and your application.

To generate an API key:

Select the API Keys option from the Accounts Menu in the upper right-hand corner (accessed by clicking on your name). This will open the API Keys Window.

The table displays any API keys that you have currently enabled. There is no limit to the number of API keys that you can generate. In fact, it is a good programming practice to generate API keys for different uses.

There are a number of actions you can carry out with API keys from the API Key Window:

  • Enable or Disable a key—click the Enable or Disable Link under the Options Column to enable or disable an API key. If an API key is enabled, it can be used to send and receive communication with our system. If an API key is disabled, any call made against it will return an error message.
  • Add a key—to add a key, click the Add a Key Icon. This will generate a new key that will appear in the API keys table. 

Using APIs

We provide a number of programming examples how to use API keys in your applications. Examples range from PHP to Python to Java. To download a .zip file with sample code, simply click on the link at the top of the API Keys Window that represents your programming language of choice.

API Call History

At the bottom of the API Keys Window, a graph displays all of the historical API calls that have happened against any of the currently provisioned and enabled API keys. Additionally, the table below the graph displays each call that has been made including a number of important data points that can be useful when troubleshooting issues with API key operation:

  • Source IP—the IP of the incoming request
  • Date/Time—the date and time when the request was made
  • Exec Time—the time needed to complete the API call (usually in seconds)
  • Call result—the result of the call (“OK” or “Failed”)
  • Method—what was called such as Lists, Adding Contacts, Creating Campaigns, etc.
  • Format—the format that was used to make the API call such as XML, PHP, etc.
  • User Agent—what was used to create the call. For example, a wrapper, the kind of wrapper, or link.
  • Version—the version of the API handler that received the call

Was this article helpful?
What can we do to improve articles like this?

© 2019 Sendserver. All rights reserved.