API Requests

API Requests

Requests are sent in accordance with the XML-RPC specification (http://www.xmlrpc.com/). An XML-RPC “struct” element is used as the payload container for all iThenticate XML-RPC requests. This allows named parameters as input data. The order of the members within the struct element is not important.

Every API request must be encrypted via Secure Sockets Layer (SSL).

Every API request must include a session id (sid). The session id is obtained by an initial “login” API request that returns the session id in the XML-RPC response.

The iThenticate API will request validation but the user is encouraged to ensure that client side requests conform to the guidelines presented in the API. Requests which do not conform to the parameters and examples shown in this document cannot be guaranteed to return correct responses, nor can they be guaranteed to return errors or messages about what elements of the request were invalid. As with HTTP requests,request parameters that are not designated for a certain method will be ignored rather than an error being thrown. See each method description for the required request parameters.

An example login request is shown here (white space inserted for readability). The username and password are passed in a struct element.

<?xml version=”1.0” encoding=”UTF-8”?><methodCall> <methodName>login</methodName> <params> <param> <value> <struct> <member> <name>password</name> <value><string>api_test_user_123</string></value> </member> <member> <name>username</name> <value><string>api_test_user@test.api.ithenticate.com</string></value> </member> </struct> </value> </param> </params></methodCall>

Thank you! Your feedback will help us to improve this guide.

Was this page helpful?

We're sorry to hear that

If you have the time, we'd love to know how we could improve it.

Need to contact a human?

Get in touch