Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

MailUp REST API follows OAuth 2.0 specification and authorizes only the applications that specify a pair of valid access keys ("Client ID" and "Client Secret") in the authentication process. 

...

First get your API access keys

To get your access keys, you must register your application by following this procedure:  

  • Request a MailUp Developer account.
  • Log into your MailUp Developer account and click on the "Developer" tab in the navigation bar on the left. You can now request your MailUp API keys by pressing the "+" button and filling out the form. You will be asked to fill out a brief form.
  • Then press the "Request keys" button. 
  • Finally, you get to a page that contains the "Access keys". You can copy those keys and paste them in your application. When registering your application, you can ignore the "Request publication" button

 

Expand
titleScreenshots - click here to view the involved pages

Gallery
columns3
exclude4.png
sortname

 

Basic concepts

Make sure you clearly understand the role of access keys, developer accounts and MailUp user credentials. These notes should be useful:

...

the procedure that is described here.

 

Basic concepts

Make sure you clearly understand the role of access keys, developer accounts and MailUp user credentials. These notes should be useful:

  • API access keys identify a software application (e.g. a plugin for Salesforce that uses MailUp REST API).
    • Access keys are used according to the roles of "client ID" and "client secret" in OAUTH 2.0 specifications.
    • You can use them with any MailUp account, regardless the developer account they were created from.
    A developer account is a free account provided by MailUp to let you either generate one the access keys or to test your application. You cannot generate access keys using a regular account
    • .0 specifications.
    • You can use them with any MailUp account, regardless the account they were created from.
    • By requesting a pair of keys, you register your application. So you have to provide details about it and its author.You may also use this developer account to edit the details of your previously registered application(s) and also to apply for adding your application to MailUp's Integration Catalog
  • A developer account is a free platform that could be requested to MailUp in case your regular account does not let you generate the API access keys.
    • A developer account cannot be converted into a production account and you cannot purchase a subscription plan for it. Use it just for the purposes stated above. You should design your application in such a way that switching from your developer account to a paid production account is very easy. You should be able to switch by simply changing the user credentials in your applicationand you cannot purchase a subscription plan for it. Use it just for the purposes stated above
  • User credentials are the username and the password that identify an user of a specific MailUp account
    • When you start using an application, you are asked to provide the credentials of the MailUp account your application has to be connected to. Only at this moment you are linking a pair of access keys to a MailUp user
    • Since the allowed relationships between access keys and MailUp users are "many-to-many", you can use the same access keys with several MailUp accounts.

...

  • Your application will be authorized to communicate with MailUp using a pair of access keys ("Client ID" and "Client Secret") that you have previously generated by means of a "developer account".
  • Users of your application will be authenticated using their regular MailUp user credentials

...

An application can access to an account's resources only if it has been registered through a developer account and a valid pair of API keys and a valid access token is provided.

...