...
Note |
---|
The WS_MailUpImport methods support up to 20 personal data fields. Should it be necessary to import more than 20 fields, there are other procedures that can be used. For example:
|
API registration and activation
WS_MailUpImport can be used only after configuring the IP address of the caller. This can be made through the MailUp console or by calling a specific activation method.
The username and password defined for the API account, used to call the web services, are different from those used to access the MailUp console.
Activation via the "Manage" page in the MailUp console
From the menu on the left of the screen in the administration console, select Manage > Web services. The page presents itself as shown in the image below. Inserting an IP address allows to call WS_MailUpImport methods from that very address. All the administration consoles are created with specific username and password for web services: this page also allows to change the password or disable the account.
Activation via call to an URL
A third party application can enable web services via a call to
...
- usr: MailUp API Account username (e.g. a7132)
- pwd: MailUp API Account password
- nl_url: Console URL (e.g abcd.sp09.com, omitting "http://" )
- ws_name: Web service name (specify: "WSMailUpImport")
...
Sample WSActivation response
Code Block | ||||
---|---|---|---|---|
| ||||
<mailupMessage>
<mailupBody>
<ReturnCode>0</ReturnCode>
<WS_Activation>
<WS_Name> WS_MailUpImport </WS_Name>
<DateOfRequest>2008-01-16</DateOfRequest>
<User>admin</User>
</WS_Activation>
</mailupBody>
</mailupMessage > |
ReturnCodes
Code | Description |
---|---|
0 | request execution succeeded |
-2 | ws name has not been specified (1) |
-4 | user name has not been specified (1) |
-8 | password has not been specified (1) |
-16 | nl url has not been specified (1) |
-1000 | unrecognized error |
-1001 | the account is not valid |
-1002 | the password is not valid |
-1003 | suspended account |
-1004 | inactive account |
-1005 | expired account |
-1006 | the web service is not enabled |
-1007 | the web service is not active |
-1008 | the web service is already active |
-1009 | web service activation error |
-1010 | IP registration error |
...