|
Update Nov 2017: API keys can be created through the main account, so the activation of a developer account is no more mandatory. You have to activate it only if you need it (see use cases at the bottom of this page).
To use MailUp REST API, first, you need to create an app. MailUp REST API accepts connections only from apps (i.e. client applications) that are pre-registered through the MailUp web interface. During this registration process, "Client ID" and "Client Secret" keys (aka API keys) are returned*.
Regardless you are developing an integration for your purpose or you would like to distribute it as a generic connector, you need these keys to authenticate with MailUp REST API.
You don't need API keys if your integration is based only on SMTP+, transactional API, SOAP API, or others.
*That's because our REST API uses OAuth2 authentication, and therefore your "application" needs to be uniquely identified via API keys and authorized to communicate with MailUp. Once the application has been authorized, user authentication is then handled via MailUp account credentials (i.e. the same application can be used by N different users).
MailUp allows access to a dedicated page that allows you to create an app and get its API keys.
**If you have a Whitelabel account, you won't have access to this page. In this case, you must request a "developer" MailUp account and get the keys using it. As stated in the previous paragraph, API keys are not tied to a specific MailUp account, so you are free to use them with an account that is not the one you used to create them
Because the system is set up to allow for a scenario where the same application is used by many MailUp users.
Therefore, it separates the concepts of authorization and authentication.
As a developer of integration with MailUp, you may need a separate account (aka "developer account") in these cases:
Use case | How to get a new developer account |
---|---|
Your main account is already in production and you need a separate environment (staging) where you can test future versions of your application | Select "Create a developer account to get started" on the bottom of Settings > Account settings > Integrations. In the "Company" form field, please provide the same name as you provided for the main account, together with the ID of your main account (e.g. "Acme Ltd. m1234") |
To get the API keys if your main MailUp account does not provide this option (i.e. it's a Whitelabel account) | Please fill in this request form In the "Company" form field, please provide the same name as you provided for the main account, together with the ID of your main account (e.g. "Acme Ltd. m1234") |
You are a system integrator (i.e. not a MailUp customer) who wants to develop a connector between MailUp and a third party commercial platform | Please fill in this request form |
Duration: unlike free trial accounts, developer accounts don't expire in a short time (e.g. 30 days). Their actual duration is usually tied to the validity period of your main account (if you have one) or it can be set according to the integration you are working on (please contact us).
Usage and restrictions: they do have sending limitations like free trial accounts and they are not for use in a production environment.
If you have developed an integration with MailUp and want it to be featured inside our integrations catalog, please submit it for review by writing an email to product@mailup.com with the following information:
Once we review the submission, we will get in touch with you and, if approved, your integration will be featured in our integrations catalog.
Do not submit your integration if it's for internal use or testing purposes (i.e. the integration will work properly anyway).