...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
Table of Contents |
---|
Management
Use these methods to retrieve informations about your environment (profiles, packages and languages).
Note that all management requests ignore ExternalUserId value, so your client can perform these requests having or not this value.
Get retailer-defined profiles
...
Description
...
Get retailer-defined profiles
...
HTTP Method
...
GET
...
URL
...
Code Block |
---|
https://services.mailup.com/API/v1.1/Rest/RetailerService.svc/Management/Profile |
...
JSON request (example)
...
none
...
JSON response (example)
...
Info |
---|
This page is a reference manual for the API to be used for developing a custom solution of automatic account provisioning. MailUp APS is built on top of this API and it should be your first option for account provisioning. As for the MailUp APS, the access to this API is not "self-service", you should first contact us to ask for enabling your application for account provisioning and to agree on setup details. |
On this page:
Table of Contents |
---|
Management
Use these methods to retrieve pieces of information about your environment (profiles, packages, and languages) and configure your environment.
Note that all management resource requests ignore ExternalUserId value, so your client can perform these requests having or not this value.
Anchor | ||||
---|---|---|---|---|
|
Description | Get retailer-defined profiles | ||||
---|---|---|---|---|---|
HTTP Method | GET | ||||
URL |
| ||||
JSON request (example) | none | ||||
JSON response (example) |
| ||||
Paging and filtering (example) |
|
Anchor | ||||
---|---|---|---|---|
|
To retrieve available languages you need to provide this parameter:
Required | Where | Description | |
---|---|---|---|
id_Profile | X | URL | See get profile |
Description | Get retailer-defined profile-packages relationship | ||||
---|---|---|---|---|---|
HTTP Method | GET | ||||
URL |
| ||||
JSON request (example) | none | ||||
JSON response (example) |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Paging and filtering (example)
Code Block |
---|
https://services.mailup.com/API/v1.1/Rest/RetailerService.svc/Management/Profile?PageSize=2&PageNumber=1 |
Get retailer-defined packages by profile
Description
Get retailer-defined profile-packages relationship
HTTP Method
| |||||
Paging and filtering (example) |
|
---|
Errors
HTTP Status Code | When | Message |
---|---|---|
403 Forbidden | Unexisting id_profile | You cannot access the provided profile. |
id_profile not assigned to a specified Retailer account |
Note
- Min e Max equals the minimum and a maximum number of packages manageable by selected profile.
Anchor GetLanguages GetLanguages
Get the available languages by profile
GetLanguages | |
GetLanguages |
To retrieve available packages you need to provide this parameter:
Required | Where | Description | |
---|---|---|---|
id_Profile | X | URL | See get profile |
Description | Get the available languages by profile | ||
---|---|---|---|
HTTP Method | GET | ||
URL |
|
Status | ||||
---|---|---|---|---|
|
| ||
JSON request (example) | none | |
---|---|---|
JSON response (example) |
|
Code Block |
---|
{
"IsPaginated":false,
"Items":[
{
"ClientCode":1,
"Description":"Pacchetto che consente di aumentare la velocità di invio di 300 mail\/ora",
"Id":534,
"Max":5,
"Min":1,
"Name":"VelocitaAggiuntiva300"
},
{
"ClientCode":2,
"Description":"Pacchetto che consente di aggiungere 300 crediti alla console",
"Id":535,
"Max":65535,
"Min":1,
"Name":"Crediti300"
}],
"PageNumber":0,
"PageSize":20,
"Skipped":0,
"TotalElementsCount":2
} |
Paging and filtering (example)
none
Errors
HTTP Status Code | When | Message |
---|---|---|
403 Forbidden | Unexisting id_profile | You cannot access to provided profile. |
id_profile not assigned to specified Retailer account |
Note
- Min e Max equals to the number of packages manageable by selected profile.
Get the available languages by profile
Description | Get the available languages by profile | ||||
---|---|---|---|---|---|
HTTP Method | GET | ||||
URL |
| ||||
JSON request (example) | none | ||||
JSON response (example) |
| ||||
Paging and filtering (example) | none |
Errors
HTTP Status Code | When | Message |
---|---|---|
403 Forbidden | Unexisting id_profile | You cannot access to provided profile. |
id_profile not assigned to specified IdConsoleRetailer |
Account
Create a reseller's customer account
| |||
Paging and filtering (example) | none |
---|
Errors
HTTP Status Code | When | Message |
---|---|---|
403 Forbidden | Unexisting id_profile | You cannot access the provided profile. |
id_profile not assigned to specified IdConsoleRetailer |
Account
Use these methods to manage retailers' customer's accounts. With these methods, you can create new accounts, add or remove packages and get what you need to log in to accounts.
Note that all account resource requests need an ExternalUserId value, so you have to authenticate specifying the retailer's customer unique identifier. APIs validates client requests forbidden the access if:
- AccessToken contains an empty ExternalUserId
- AccessToken contains an ExternalUserId that hasn't got the right scope to perform the required operation.
Anchor CreateAccount CreateAccount
Create a retailer's customer account
CreateAccount | |
CreateAccount |
The process to create an account could take some time. To create a new account you have to provide this information:
Required | Where | Description | |
---|---|---|---|
id_Profile | X | URL | See get profile |
lang | X | URL | See get languages |
IpAddress | X | Body | Your client IP address |
X | Body | Your customer's email address | |
CustomDomain | X | Body | Your product or your customer domain |
CustomSubdomain | X | Body | Your product or your customer subdomain to address this service |
ServiceName | X | Body | Your product name |
ServiceUrl | X | Body | Your product web site |
ServiceLogoutUrl | X | Body | Address to redirect the customer when logouts |
UserAgent | Body | Your client user agent | |
Referer | Body | Your client referer |
This method returns an activation identifier to prevent client hanging. When the method responds, your clients have to poll the activation status method to understand when the creation process ends. The response could contain domains that should be redirected to MailUp CNAMEs adding DNS records.
Description | Create a retailer's customer account | ||
---|---|---|---|
HTTP Method | POST | ||
URL |
|
Required | Where | |
---|---|---|
id_Profile | X | URL |
lang | X | URL |
IpAddress | X | Form request |
UserAgent | Form request | |
Referer | Form request | |
X | Form request | |
CustomDomain | X | Form request |
CustomSubdomain | X | Form request |
ServiceName | X | Form request |
ServiceUrl | X | Form request |
ServiceLogoutUrl | X | Form request |
Required | Who | Where | |
---|---|---|---|
ExternalUserId | X | AuthorizationCode | Authorization Flow |
IdAnagrafica | X | IdAnagrafica field of Newsletter table where id = DeveloperId of APIConsumerApplication | Database |
IdProfilo | X | Given by Reseller | Request API |
IP | X | Given by Reseller | Request API |
UserAgent | Given by Reseller | Request API | |
Referer | Given by Reseller | Request API | |
X | Given by Reseller | Request API | |
Lang | X | Given by Reseller | Request API |
CustomDomain | X | Given by Reseller | Request API |
An object containing these fields:
- id_Activation
- Hash
- Code
- Description
- ControlPanelDomain
- LinkTrackingDomain
- ImageTrackingDomain.
JSON request (example) |
| ||||
---|---|---|---|---|---|
JSON response (example) |
| ||||
Paging and filtering (example) | none |
Errors
HTTP Status Code | When | Message |
---|---|---|
400 BadRequest | Unexisting lang value into the TwoLetterISOLanguageName list. | Invalid language. |
ExternalUserId empty. | Invalid ExternalUserId. | |
403 Forbidden | No profiles for the ResellerId authentication code value. | You cannot access the provided profile. |
Internal error occurred | Code: -1 Description: Unknown account activation status. | |
You are not able to create this account | Code: 2 Description: Error | |
Language provided is not allowed for this retailer's edition | Code: 3 Description: Language '{lang}' is not available for profile {id_Profile}. | |
IpAddress is null, empty, or IPAddress.TryParse fails | Code: 4 Description: IpAddress cannot be null, empty, or invalid. | |
IpAddress is null, empty, or EmailHelper.ValidateAddress fails | Code: 5 |
Description: Email cannot be null, empty, or invalid. |
The request contains some null, empty, or invalid domain fields | Code: 6 Description: Domains cannot be null, empty, or invalid. |
One or more domains not available | Code |
= 7 |
; Description: Custom domain not available. |
Code: 8 |
; Description: Link tracking domain not available |
Code: 9 |
; Description: Image tracking domain not available | |
Invalid retailer's service information | Code: 10 |
; Description: Service name cannot be null, empty, or invalid. |
Code: 11 |
; Description: Service |
URL cannot be null, empty, or invalid. |
Code: 12 |
; Description: Service logout |
URL cannot be null, empty, or invalid. |
WHEN REQUESTS RUN:
- ExternalUserId, id_Profile, lang, IpAddress, Email, ServiceName, ServiceUrl, ServiceLogoutUrl CustomSubdomain and CustomDomain MUST HAVE a value
- UserAgent and Referer could be empty
WHEN REQUESTS FAIL:
...
403 Forbidden
...
No profiles for the ResellerId authentication code value.
...
Code: 4
Description: IpAddress cannot be null, empty or invalid.
...
Code: 5
Description: Email cannot be null, empty or invalid.
...
Code: 6
Description: Custom domain cannot be null, empty or invalid.
...
Code = 7;
Description = Custom domain not available.
...
Code: 3
Description: Language '{lang}' is not available for profile {id_Profile}.
NOTE:
- E' possibile creare UN SOLO account TRIAL per ExternalUserId. Se si cerca di creare un account trial utilizzando un ExternalUserId già utilizzato, la risposta conterrà Code: 1, Description: Processing fino a che il primo account non è stato creato, ed al termine della sua creazione conterrà Code: 2, Description: Error.
- E' possibile creare PIU' account ECONOMY o PREMIUM per ExternalUserId. Se si cerca di creare un account economy o premium utilizzando un ExternalUserId già utilizzato, la risposta conterrà Code: 1, Description: Processing fino a che il primo account non è stato creato, ed al termine della sua creazione conterrà Code: 0, Description: Ok.
Get reseller's customer account profile activation status
...
Account/Activation/{id_Activation}/Status
NOTE: the id_Activation is the value returned with Create a reseller's customer account resource
...
Required | Where | |
---|---|---|
id_Activation | X | URL |
...
Required | Who | Where | |
---|---|---|---|
id_Activation | X | Given by Reseller | Request API |
...
An object (like ConsoleActivationStatusResponse object for PublicService) containing:
- Code (0: Ok, 1: Processing, 2: Error, 3: An error occurred finalizing account creation)
- Description (Ok, Processing, Error, An error occurred finalizing account creation)
- IdAccount
NOTE: the IdAccount field contains a value ONLY when the reseller's customer console is propertly created, so Code field contains the OK-CREATED code value.
NOTE2: the IdAccount equals to ConsoleId
WHEN REQUESTS RUN:
- ExternalUserId and id_Activation MUST HAVE a value
- id_Activation MUST be a numeric value
...
Note
- It is possible to create ONLY ONE Trial Control Panels per ExternalUserId. If you try to create more Trials using the same ExternalUserId the response contains Code: 1, Description: Processing until the process ends, and then it contains Code: 2, Description: Error.
- It is possible to create MORE non Trial Control Panels per ExternalUserId. If you try to create more non Trials using the same or another ExternalUserId the response contains Code: 1, Description: Processing until the process ends, and then it contains Code: 0, Description: Ok.
Anchor | ||||
---|---|---|---|---|
|
Finalize your account creation process checking its status. To finalize a new account creation process you have to provide this information:
Required | Where | Description | |
---|---|---|---|
id_Activation | X | URL | See create account |
Description | Get retailer's customer account profile activation status | ||||||
---|---|---|---|---|---|---|---|
HTTP Method | GET | ||||||
URL |
| ||||||
JSON request (example) | none | ||||||
JSON response (example) |
| ||||||
Paging and filtering (example) | none |
Errors
HTTP Status Code | When | Message |
---|---|---|
400 BadRequest | ExternalUserId empty. | Invalid ExternalUserId. |
ExternalUserId validation fails | ||
id_Activation is not a number | Invalid activation. | |
403 Forbidden | Unknown account activation status phase | Code = -1 Description = Unknown account activation status |
Account activation failed | Code = 2 Description = Error | |
Link or image tracking domains, service name, URL, or logout URL cannot be set | Code = 3 Description = An error occurred finalizing account creation |
Note
- the IdAccount field contains a value ONLY when the new account is properly created, so the Code field contains the 0 - OK code value.
Change retailer’s customer account profile
Method to change the profile. To change your account profile you have to provide this information:
Required | Where | Description | |
---|---|---|---|
id_Account | X | URL | See activation status response |
id_Profile | X | URL | See get profiles |
Description | Change retailer’s customer account profile | ||
---|---|---|---|
HTTP Method | PUT | ||
URL |
| ||
JSON request (example) | none | ||
JSON response (example) | none | ||
Paging and filtering (example) | none |
Errors
HTTP Status Code | When | Message |
---|---|---|
400 BadRequest | ExternalUserId empty. | Invalid ExternalUserId. |
ExternalUserId validation fails | ||
403 Forbidden | Invalid id_ |
Change reseller's customer account profile
Status | ||||
---|---|---|---|---|
|
Account/{id_Account}/Profile/{id_Profile}
NOTE: the id_Account is the value returned with Get reseller's customer account profile activation status resource
Required | Where | |
---|---|---|
id_Account | X | URL |
id_Profile | X | URL |
profile | You cannot access the provided profile. |
Invalid id_account | You cannot access the provided account. |
Note
the return value is the HTTP status code of the response. API executes this operation asynchronously. Every time the client invokes the method, it returns a code. If this code tells that the operations are still in progress the resource returns a 202 Accepted status code; otherwise returns a 200 OK status code. If an error occurred it returns a 500 Internal Server Error.
the client can invoke the resource as many times as it wants.
Get retailer's customer account status
Method to verify the account status. To retrieve the account status you have to provide this information:
Required | Where | Description | |
---|---|---|---|
id_Account | X |
-
NOTE: the return value is the HTTP Status code of the response. ADM executes this operation asynchronously. Every time the reseller invokes the resource, ADM returns a code. If this code tells that the operations are still in progress the resource returns an 202 Accepted status code; otherwise returns a 200 OK status code. If an error occurred it returns 500 Internal Server Error.
NOTE 2: the reseller can invoke the resource as many times as it wants.
WHEN REQUESTS FAIL:
HTTP Status Code | When | Message |
---|---|---|
400 BadRequest | ExternalUserId empty. | Invalid ExternalUserId. |
ExternalUserId validation fails |
...
Http verb |
| |||||||||
---|---|---|---|---|---|---|---|---|---|---|
Resource URL | Account/{id_Account} or Account/{id_Account}?Enable=false NOTE: the id_Account is the value returned with Get reseller's customer account profile activation status resource | |||||||||
Request API |
| |||||||||
Request ADM | None | |||||||||
Return value | The resource returns a 200 OK status code and and object containing account status properties. In detail the returned object actually contains:
|
WHEN REQUESTS FAIL:
URL | See activation status response |
The table below shows the possible status, specifying related response fields meaning:
Status | Response Code field value | Response Description field value |
---|---|---|
Error / Processing | -1 | Error or Processing |
Enabled | 0 | Enabled |
Disabled | 1 | Disabled |
Unprovided | 2 | Unprovided |
Description | Get retailer’s customer account status | ||||
---|---|---|---|---|---|
HTTP Method | GET | ||||
URL |
| ||||
JSON request (example) | none | ||||
JSON response (example) |
| ||||
Paging and filtering (example) | none |
Errors
WHEN REQUESTS FAIL:
HTTP Status Code | When | Message |
---|---|---|
400 BadRequest | ExternalUserId empty. | Invalid ExternalUserId. |
ExternalUserId validation fails |
Enable reseller's customer account info
Http verb |
| |||||||||
---|---|---|---|---|---|---|---|---|---|---|
Resource URL | Account/{id_Account} or Account/{id_Account}?Enable=true NOTE: the id_Account is the value returned with Get reseller's customer account profile activation status resource | |||||||||
Request API |
| |||||||||
Request ADM | None | |||||||||
Return value | The resource returns a 200 OK status code and and object containing account status properties. In detail the returned object actually contains:
|
WHEN REQUESTS FAIL:
HTTP Status Code | When | Message |
---|---|---|
400 BadRequest | ExternalUserId empty. | Invalid ExternalUserId. |
ExternalUserId validation fails |
Unprovide reseller's customer account
...
Account/{id_Account}
NOTE: the id_Account is the value returned with Get reseller's customer account profile activation status resource
...
Required | Where | |
---|---|---|
id_Account | X | URL |
...
403 Forbidden | Invalid Id_Account | You cannot access the provided account. |
Note
- La chiamata ritorna -1 se il metodo GetAccountStatus dei servizi ADM ritorna come ReturnCode 1 (Processing) o 2 (Error). Tale descrizione del ReturnCode viene settata come description in modo che si possa capire il motivo del fallimento. In realtà ReturnCode, in questo caso, varrà 0 (Ok) oppure 2 (Error) e MAI 1 (Processing).
- La proprietà ActivePacks restituisce informazioni relative allo stato attuale dei pacchetti. Il campo Quantity restituisce la somma algebrica dei pacchetti aggiunti/rimossi, mentre CurrentQuantity fornisce informazioni relative a quanti pacchetti sono attualmente in uso (un pacchetto potrebbe essere stato rimosso, ma l'effettiva rimozione avverrà a fine mese)
Disable retailer's customer account
Method to disable an account.
Required | Where | Description | |
---|---|---|---|
id_Account | X | URL | See activation status response |
Enable | Querystring | Could be FALSE |
Description | Disable retailer's customer account | ||||
---|---|---|---|---|---|
HTTP Method | PUT | ||||
URL |
| ||||
JSON request (example) | none | ||||
JSON response (example) |
| ||||
Paging and filtering (example) | none |
Errors
HTTP Status Code | When | Message |
---|---|---|
400 BadRequest | ExternalUserId empty. | Invalid ExternalUserId. |
ExternalUserId validation fails |
...
Enable reseller's customer account
...
Account/{id_Account}/Status
NOTE: the id_Account is the value returned with Get reseller's customer account profile activation status resource
...
Required | Where | |
---|---|---|
id_Account | X | URL |
...
An object contains these fields:
- Code (numeric)
- 0: Enabled
- 1: Disabled
- 2: Unprovided
- -1: Error or Processing
- Description (string)
- Enabled
- Disabled
- Unprovided
- Error or Processing
- ValidFrom (string, it's a DateTime)
- ValidTo (string, it's a DateTime)
- IdAccount
- Credits
- ActivePacks
- Id
- Quantity
- CurrentQuantity
WHEN REQUESTS FAIL:
info
Method to enable a disabled account. A disabled account cannot be enabled in the future.
Required | Where | Description | |
---|---|---|---|
id_Account | X | URL | See activation status response |
Enable | X | Querystring | Must be TRUE |
Description | Enable a disabled retailer's customer account | ||||
---|---|---|---|---|---|
HTTP Method | PUT | ||||
URL |
| ||||
JSON request (example) | none | ||||
JSON response (example) |
| ||||
Paging and filtering (example) | none |
Errors
HTTP Status Code | When | Message |
---|---|---|
400 BadRequest | ExternalUserId empty. | Invalid ExternalUserId. |
ExternalUserId validation fails |
NOTE:
- La chiamata ritorna -1 se il metodo GetAccountStatus dei servizi ADM ritorna come ReturnCode 1 (Processing) o 2 (Error). Tale descrizione del ReturnCode viene settata come description in modo che si possa capire il motivo del fallimento. In realtà ReturnCode, in questo caso, varrà 0 (Ok) oppure 2 (Error) e MAI 1 (Processing).
- La proprietà ActivePacks restituisce informazioni relative allo stato attuale dei pacchetti. Il campo Quantity restituisce la somma algebrica dei pacchetti aggiunti/rimossi, mentre CurrentQuantity fornisce informazioni relative a quanti pacchetti sono attualmente in uso (un pacchetto potrebbe essere stato rimosso, ma l'effettiva rimozione avverrà a fine mese)
Add package to reseller's customer account
...
Status | ||||
---|---|---|---|---|
|
...
Account/{id_Account}/Pack/{id_Pack}
NOTE: the id_Account is the value returned with Get reseller's customer account profile activation status resource
...
Unprovide reseller's customer account
Method to unprovide an account. An unprovided account cannot be enabled in the future.
Required | Where | Description | |
---|---|---|---|
id_Account | X | URL | See activation status response |
Description | Unprovide a retailer's customer account | ||||
---|---|---|---|---|---|
HTTP Method | DELETE | ||||
URL |
| ||||
JSON request (example) | none | ||||
JSON response (example) |
| ||||
Paging and filtering (example) | none |
Errors
HTTP Status Code | When | Message |
---|---|---|
400 BadRequest | ExternalUserId empty. | Invalid ExternalUserId. |
ExternalUserId validation fails |
Add the package to the retailer's customer account
Method to add packages to the selected account.
Required | Where | Description | |
---|---|---|---|
id_Account | X | URL | See activation status response |
id_Pack | X | URL | See get packages |
Quantity | X | Body | Numeric value that depends on WorkMode. Please refer to the row below. |
WorkMode | X | Body |
Should be "incremental" or "absolute" and refers to the way to manage packages. The "incremental" work mode allows the client to add or remove packages as defined by the Quantity field. If a client calls the method 3 times with quantity equals |
1, the API method adds 1 package each time. If a client needs to remove a package it calls the method with quantity equals to -1 and the API method removes a package. The "absolute" work mode allows the client to define the total number of packages. If a client calls the method with quantity equals |
4, the API method adds 4 packages. If a client needs to remove 2 packages from the current quantity (set to 4 by the previews call) it calls the method with quantity equals |
2 and the API method removes 2 packages. NB: "absolute" work mode allows only unsigned value for Quantity. |
Required | Who | Where | |
---|---|---|---|
id_Account | X | Given by Reseller | Request API |
id_Pack | X | Given by Reseller | Request API |
In detail the returned object actually contains:
- Code: int value corresponding to the account status code
- 0: Ok
- 1: Quantity_limits_exceeded
- 2: Profile_rules_error
- 3: Invalid_quantity
- 4: Invalid_workmode
- Description: human readable description of the account status code
- Ok
- Quantity limits exceeded
- Profile rules error
- Invalid quantity
- Invalid workmode
Description | Add the package to the retailer's customer account | ||||||
---|---|---|---|---|---|---|---|
HTTP Method | POST | ||||||
URL |
| ||||||
JSON request (example) |
| ||||||
JSON response (example) |
|
|
|
WHEN REQUESTS RUN:
|
...
|
...
|
...
WHEN REQUESTS FAIL:
...
403 Forbidden
...
The package cannot be added
...
the response contains an object with:
- Code = 1
- Description = Quantity limits exceeded
- Code = 2
- Description = Profile Rules Error
NOTE
- Non si possono aggiungere/rimuovere pacchetti ad un profilo TRIAL
- Non di possono rimuovere pacchetti a consumo dai profili Economy e Premium
- La tabella RetailerProfilePack definisce il numero di pacchetti Massimo e Minimo previsti per il profilo. La visibilità del pacchetto per l'utente finale (e quindi la sua attivabilità) è gestita con il campo IsActivable.
- Nel caso la risposta abbia lo status code settato a 403 Forbidden si ottiene la risposta con Code=1 quando la richiesta non viene validata dai limiti previsti dalla tabella RetailerProfilePack, mentre Code=2 quando la validazione secondo i limiti della tabella retailerProfilePack è ok ma fallisce l'operazione lato ADM. Un caso in cui può essere ritornato Code=2 è quando s cerca di cancellare un pacchetto a consumo (crediti).
Get reseller's customer account logins
The resource allows to retrieve the logins available for this account/console. It is necessary if the reseller allows his customers to add more administrators to an account.
...
Required | Where | |
---|---|---|
id_Account | X | URL |
...
A list of AccountLogin object containing:
- idLogin
- Username
NOTE: data come from Newsletters_Login table. idLogin is the id and UserName is the username fields
...
| |||||||||||||||
Paging and filtering (example) | none |
---|
Errors
HTTP Status Code | When | Message |
---|---|---|
400 BadRequest | IdPack is not numeric | Invalid pack. |
ExternalUserId empty. | Invalid ExternalUserId. | |
ExternalUserId validation fails |
Note
- It is impossible to remove packages from the TRIAL profile
- It is impossible to remove credits-related packages
Anchor | ||||
---|---|---|---|---|
|
The resource allows retrieving the logins available for this account/console. It is necessary if the retailer allows his customers to add more administrators to an account.
Required | Where | Description | |
---|---|---|---|
id_Account | X | URL | See activation status response |
Description | Unprovide a retailer's customer account | ||||
---|---|---|---|---|---|
HTTP Method | GET | ||||
URL |
| ||||
JSON request (example) | none | ||||
JSON response (example) |
| ||||
Paging and filtering (example) | https://services.mailup.com/API/v1.1/Rest/RetailerService.svc/Account/{id_Account}/Login?PageSize=2&PageNumber=1 |
Errors
HTTP Status Code | When | Message |
---|---|---|
400 BadRequest | ExternalUserId empty. | Invalid ExternalUserId. |
ExternalUserId validation fails |
Get
...
retailer's customer account login
...
URL
The method provides the URL to log in to the account.
Required | Where | Description | |
---|---|---|---|
id_Account | X | URL | See activation status response |
id_Login | X | URL | See get logins response |
Description | Get retailer's customer account login URL | ||
---|---|---|---|
HTTP Method | GET | ||
URL |
|
NOTE: the id_Account is the value returned with Get reseller's customer account profile activation status resource
Required | Where | |
---|---|---|
id_Account | X | URL |
...
JSON request (example) | none | ||||
---|---|---|---|---|---|
JSON response (example) |
| ||||
Paging and filtering (example) | none |
Errors
HTTP Status Code | When | Message |
---|---|---|
400 BadRequest | ExternalUserId empty. | Invalid ExternalUserId. |
ExternalUserId validation fails |
...