Our API allows you to benefit from our powerful systems in highly customized ways, connecting our communications tools with your existing systems and allowing you to streamline processes such as:
Note: we also offer a JSONP API for creating subscriptions. Read all about it here.
The examples below detail some of the most common uses of GovDelivery's Communications Cloud version 1 API. These examples are meant to function like recipes, listing the ingredients (methods) required to accomplish a task.
Automatically Send Content From Your CMS Upon Creation
Batch and Sync Subscribers With a Directory
Create Topics from Another Database
Creating custom integrations using our APIs requires programming skills. Many of our clients engage contract programmers for this purpose. If you do not have access to a programmer, contact Customer Support at email@example.com to ask about the professional development services we can provide.
Before you can create custom integrations using our APIs, you must contact Customer Support at firstname.lastname@example.org. They will provide you with an authorization token, a development environment, and other necessary information, such as account details, to start you down the API programming path.
In order to develop with our API, you will need the following information from the Communications Cloud interface.
To develop against our API, you'll need a server. Our API is a web service, which means that you will also need to connect to it over the Internet. If you have a proxy set up on your development machine, you will need a way to get around it.
Our API is based on Representational State Transfer (REST). REST APIs provide access to resources (data entities) via URI paths. Resources available through this API include things like bulletins, categories, or subscribers. REST APIs operate over HTTP(S) making it easy to use with any programming language or framework. To use a REST API, your application will make a request using standard HTTP methods. For example, send a GET to a resource to see a list of the available entities.
Review the principles of REST before you begin. You can find a good primer here.
You can use RESTClient (for Firefox) or Postman (for Chrome) to test out the methods for this API (use the stage base URL).
Was this page helpful? Can't find what you need? Let us know
Open topic with navigation