API input formats

REST

The REST (REpresentational State Transfer) architecture is not itself a standard but defines a common way of requesting a web service: sending a list of parameters to an entry point using GET or POST. The requests must be sent to the following URL:

https://api.ipernity.com/api/[method]/[format]

• [method]: the API method called.
• [format]: the output format desired.

SOAP

A request in SOAP format uses an XML envelope in a specific format and must be posted to the following URL:

https://api.ipernity.com/api/soap

The API method should not appear in the URL (it is replaced by xmlrpc), but must appear in the <method> field. The response format is SOAP by default but another format can be chosen. For example https://api.ipernity.com/api/soap/json.

For example, here is a call to the method test.echo:

<s:Envelope
 xmlns:s="http://www.w3.org/2003/05/soap-envelope"
 xmlns:xsi="http://www.w3.org/1999/XMLSchema-instance"
 xmlns:xsd="http://www.w3.org/1999/XMLSchema">
 <s:Body>
 <x:ipernityRequest xmlns:x="urn:ipernity">
 <method>test.echo</method>
 <name>value</name>
 </x:ipernityRequest>
 </s:Body>
</s:Envelope>

XML-RPC

A request in XML-RPC uses an XML envelope of a specific format and must be posted to the following URL:

https://api.ipernity.com/api/xmlrpc

The API method shouldn't be shown in the URL (it is replaced by XMLRPC), but must be shown in the <methodName> field. The response format is XML-RPC by default, but another format can be chosen. For example https://api.ipernity.com/api/xmlrpc/json.

For example, here is a call to the method test.echo:

<methodCall>
 <methodName>test.echo</methodName>
 <params>
 <param>
 <value>
 <struct>
 <member>
 <name>name</name>
 <value><string>value</string></value>
 </member>
 </struct>
 </value>
 </param>
 </params>
</methodCall>