API Reference

SocketLabs On-Demand API Developer’s Guide

©2009-2014 SocketLabs, Inc., Last Edit: July 22, 2013

Index

Overview

Introduction to our APIs

The On-Demand API enables application developers and system integrators to interact with the SocketLabs On-Demand platform programmatically. Our API provides real-time data upon request, and supports the sending of outbound email via HTTP. In this documentation, we refer to separate segments of our API by name based on what they do. Following is a summary of the capabilities we currently provide via these APIs. [▲]

Injection API

The Injection API is for On-Demand customers who need to send sets of related email messages utilizing our advanced merging functionality, or who prefer to send email via HTTP requests instead of SMTP.

Features

For technical reference, please see the Injection API Documentation. [▲]

Notification API

The Notification API is for On-Demand customers who need to track the status of all messages sent through the On-Demand network by receiving real-time notifications about each and every message event. These events are posted to a user-defined endpoint via URL encoded HTTP POSTs, and can be stored and queried against locally in order to provide near real-time statistics and status information.

Features

For technical reference, please see the Notification API Documentation. [▲]

Marketing API

The Marketing API is for On-Demand customers who want to programmatically manage data (such as contact lists) used by our marketing features (such as Newsletters and Autoresponders).

Features

  • Manage lists, which are used by our On-Demand marketing features.
  • Manage individual contact data, which is used by our On-Demand marketing features.
For technical reference, please see the Marketing API Documentation[▲]

Inbound API

The Inbound API is for On-Demand customers who need SocketLabs to parse one or more inbound mail streams, and to provide easy to process JSON messages to a user-defined endpoint. Each JSON message contains the parsed content of a single email, allowing easy integration of email content into business systems such as support desks, user forums, CRMs, and much more.

Features

For technical reference, please see the Inbound API Documentation. [▲]

Reporting API

The Reporting API is for On-Demand customers who need to access statistics about their mail stream in scenarios where the more efficient Notification API is not appropriate.

Features

For technical reference, please see the Reporting API Documentation. [▲]

Using the Email On-Demand API

Best Practices

Please follow these guidelines to the best of your ability when implementing any software that interacts with our APIs. [▲]

Technical Support

We are able to answer questions about the features and functionality of the API, as well as make recommendations about how best to use and integrate with our services. Before contacting our support staff, please be aware that we are not able to troubleshoot third-party software and code, or provide detailed information about how to work with REST, JSON, XML, HTTP, or any other technical protocol, library, or product. Only software developers comfortable working with these technologies should make use of our APIs, since we are only able to provide support to users assuming a baseline of technical knowledge.As for resources, both simple examples and more complete code samples can be found on individual API documentation pages. If there are additional questions about our APIs, please create a support ticket through http://support.socketlabs.com/. Questions about purchasing and sales should be directed to our Sales department, which can be reached by phone or through our Contact Us form. [▲]

Detailed documentation for each of our APIs can be found at the following locations:
Samples and other code resources for our APIs can be found in our public Github code repository. [▲]

Customers Who Trust in SocketLabs

You’re in good company when working with SocketLabs. Here are some companies who have also trusted SocketLabs.

Why SocketLabs?

What Our Customers Are Saying

x
MENU