Open Connection
This method provides a session token when given valid credentials.
info
The token is valid for 60 minutes. If there is a period of inactivity for 30 consecutive minutes at any point after opening the connection, the token will expire and the connection will close automatically.
This is a POST method.
REST URL
https://atmp-pub-api-www3.actito.com/transactional-api-ws/authorization
Input parameters Required parameters | Description | Output parameters | Description |
---|---|---|---|
connection | The connection envelope | return | The token to use in all other API calls |
Body Parameters | |||
login | The login provided for API access | ||
password | The password | ||
apiKey | The manager key copied from ATMP Settings>Logins. |
REST Example
Input
Method Type
POST
URL
https://atmp-pub-api-www3.actito.com/transactional-api-ws/authorization
Header
content-type application/json
accept application/json
Body
{
"login": "AcmeAdmin",
"password": "Acme2014*",
"apiKey": "CdX7CrlE_26blFNJOsgfdawh6LJ3y6pwg5PEOvA"
}
Output
Status: 201
Body: { token}
Error Descriptions
Error Output Format Example
{
"id": "7d7d0654-5001-43ca-9b57-b89297a4f85b",
"status": 400,
"message": "error message"
}
Error Messages
- The list below shows the possible error messages for the Transactional Messaging with Attachments API:
- An internal error has occurred. Please contact the Support Team if the error persists.
- The requested resource cannot be found0.
- The credentials you entered are incorrect.
- The Authorization header is missing.
- The Authorization header is incorrectly encoded.
- Basic authentication information is missing.
- The JSON object body is either invalid or missing.
- The following fields are missing or invalid.
- You do not have the following user rights for the MESSAGE feature: 0.
- The field ''0'' is required.
- You must include either the 'apiKey' field or the 'partnerKey' field.
- The field ''0'' must be numeric.
- The length of field ''0'' is greater than 1.
- Your sender is not validated for this type of message.
- No sender found with this address 0 for this type of message.
- Parameter ''0'' too long (max {1,number,#}).
- Invalid parameter: ''0''.
- The field ''0'' contains an invalid email value.
- The body of an email message must begin with [EMV TEXTPART] OR [EMV HTMLPART].
- The Transactional Message 0 cannot be deleted because it has already been sent.
- The encoding is incorrect. Choose an encoding from this list: iso-8859-15, UTF-8, windows-1251, Big5, GB2312, EUC-KR, Shift_JIS, iso-8859-2, iso-8859-3, iso-8859-7.
- Page 0 is invalid.
- Your JSON has an invalid parameter.