Calling An API Method

‹ BACK TO API PAGE


Description

All API method calls are wrapped within the <data> element. Each method call is contained within its own <methodCall> element. A single methodCall element identifies an individual action. Multiple methodCalls may be included within a single POST.

The methodCall element always contains the <methodName> element which, as its name implies, indicates the name of the method being called. Following the methodName element are any method-specific elements that contain the method's arguments. An example of a complete method call is as follows:

<api>

<authentication>

<api_key>2a6035671daba0f771c82346f2d9ccf8</api_key>

<shared_secret>c5f596647ca11497</shared_secret>

<response_type>xml</response_type>

</authentication>

<data>

<methodCall>

<methodName>utilities.checkemail</methodName>

<email>john_smith@example.com</email>

<mx_check>1</mx_check>

</methodCall>

<methodCall>

<methodName>utilities.checkemail</methodName>

<email>Jane_Doe@example.com</email>

<mx_check>1</mx_check>

</methodCall>

<methodCall>

<methodName> ... </methodName>

...

</methodCall>

</data>

</api>


Back to API Reference Guide