| Panel | ||
|---|---|---|
| ||
|
...
In order 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 own 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).
How do I get the API keys for my app?
...
- Log in to MailUp with an "admin" account,
- then go to Settings >
- After pressing "New keys", you will be asked to specify the following
- the application name (very important in case of connectors you want to share with others)
- the application description (i.e. its purpose, mandatory for featured apps in the integrations catalog)
- the developer name (the name or the email address of a reference person)
- Finally, press "Request keys" and you will be redirected to a list of apps that also shows the corresponding 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
...
Do not submit your integration if it's for internal use or testing purposes (i.e. the integration will work properly anyway).