Helcim Logo Support & Tutorials

© Copyright 2006-2019 Helcim Inc.

All Rights Reserved.

Helcim Commerce API » Misc »

Testing the Connection

This API call let's you do a connection test. The response is an XML of the result of the connection test.

Request Fields

Field Name Type Required Description
action String Yes connectionTest
accountId Integer Yes The Helcim Commerce account ID.
apiToken String Yes API token used for authentication and access control. 

Response Fields (XML)

Field Name Type Description
message - XML structure
response Integer 1 or 0. Whether the connection was succesful or not.
responseMessage String Result of the connection test.


For all API requests, there are also generic API authentication and user access restriction errors.
Response Code Error Code Message Description

Code Samples

Sample Connection Test Response XML

<?xml version="1.0"?>
    <responseMessage>Connection Successful</responseMessage>

HTML Form Sample HTML

<input type="hidden" name="accountId" value="YOUR-ACCOUNT-ID">
<input type="hidden" name="apiToken" value="YOUR-API-TOKEN">
<input type="hidden" name="action" value="connectionTest">