MailUp API - REST use OAuth v2 as authorization and authentication system to validate access to resources.
What is OAuth v2?
OAuth v2 is the next evolution of the OAuth protocol which was originally created in late 2006. OAuth v2 focuses on client developer simplicity while providing specific authorization flows for web applications, desktop applications, mobile phones, and living room devices.
This specification is being developed within the IETF OAuth WG and is based on the OAuth WRAP proposal.
The main framework was published in October 2012.
The OAuth v2 Framework was published as RFC 6749, and the Bearer Token Usage as RFC 6750.
Why OAuth v2?
There are several good features that makes OAuth v2 a preferable authentication and authorization process to interact with MailUp services and resources. First of all is simplicity. While old token authentication system was based on heavy client operation in generating valid tokens and keys (process that was not only difficult to implement for external developers but to support too), the OAuth v2 system is virtually total server based.
Summary
...
Getting started
Read our best practices to understand what you can do and learn the recommended approaches.
Download Demo Client and choose among several available programming languages.
Test Resource Access with your MailUp account. Don't have one? Request a developer account.
After getting acquainted with the API, get your API keys & build your own application.
Integrating your application
A few things to keep in mind:
The MailUp REST API uses Oauth2 and requires a token refresh. You can use the available samples to see how to refresh the authorization token
By properly setting the request header you can set the response format as JSON or XML
Each application is tied to a set of application keys, which are used to authorize the application (get yours).
- Users of the application will be authenticated using their own MailUp account credentials.
- The application keys used in the sample code shall not be used in a production environment.
| Tip | ||
|---|---|---|
| ||
Take another look at the "Getting Started" section: the demo client can help a lot. Also, before contacting us, please consider that most of the questions that we receive are about...
|
A complete email messaging API
When to use the MailUp REST APIThe MailUp REST API gives you access to a variety of methods to manage email campaigns, subscribe and unsubscribe recipients, and retrieving statistics, bounces, etc.
Recipient management | Message management | Campaign management | Statistics retrieval | Account provisioning |
|---|---|---|---|---|
Import recipients, get import status Retrieve lists, groups, email messages, etc. Subscribe, unsubscribe, update recipients Create and modify groups ...See Manage Lists and Groups and Recipients | Create, modify, delete a message Create a message from a template Retrieve a list of messages Add and remove images ...See Email messages | Send a message to a List Send a message to a Group Send a message to a Recipient ... See Send Email Messages and also Transactional Emails | Retrieve details on sent messages Retrieve opens, clicks, bounces, unsubscribes Retrieve stats for the last N hours Retrieve stats for a specific period ...See Email Statistics | Request new free trial account Obtain request status ...See Accounts |
| Info |
|---|
Before choosing the REST API as the technical solution for integrating your application, ensure that you have read our best practices. |