Authentication with Session IDs
Overview
The auth command can be used with the SOAP API to generate a session ID. Creating a session ID means that you can avoid having to re-send your username and password with every SOAP API request.
The session ID will expire after 15 minutes of inactivity after which you will have to call this command again to create a new session ID. Alternatively, you can use the Ping command about every 10 minutes to ensure that the session ID is kept alive.
Note: any API command using a session ID will cause your session ID to remain active for another 15 minutes.
SOAP API Command
auth |
auth Command Parameters
Parameter |
Description |
---|---|
user |
Your API username |
password |
Your API password |
api_id |
Your API ID |
SOAP auth Examples
All examples below are for the document/literal based server.
1 |
|
SOAP auth Code samples:
PHP
1 |
|
SOAP API responses
Example response
Successful API response
1 |
|
Error response
1 |
|
Return format
Successful SOAP API response
OK: <session ID> |
SOAP Error response
ERR: <error code>, <error description> |
Submit a Comment
Other Resources
Ask the Community
Visit Stack Overflow to join our community of developers and find the answer you need
Contact Support
Contact our support team and one of our agents will be in touch with you to answer any questions you have