API Documentation

API Key

In order to use the API, you need an API key. The API key is required to do any query through the API. You can get an API key by clicking on the "Get Key" section and completing the API form. Take a look at the chart below to review the methods available to you. It is possible to have multiple API keys. Each application created must be associated with a different API key.

Term of Use

The API terms of Use governs the rights and conditions in which each API may be used. Please review the API Term of Use for the appropriate API before using it.

Encoding

The PhotoXpress API requires all data to be UTF-8 encoded. More information about UTF-8 encoding

API calls quota

PhotoXpress limits the number of API calls by default to 500 per hour and 10000 per day.
If you expect traffic to be higher please contact support.

Methods

Methods make it possible to execute different functions through the API.

You should make calls to the url: http://www.photoxpress.com/Xmlrpc

Some methods require authentication, which requires that you call loginUser and get a session id

Subscription Purchase

You may create users using the api and then use the getUserData method to get the subscription purchase url. You may then send users to this url so that they may buy a PhotoXpress subscription. Please see the Subscription Purchase page for more details

Error Codes

You may view a full list of error codes at: Error Codes.

Query Format

XML/RPC

XML/RPC format is available for query/response. XML-RPC is a Remote Procedure Calling protocol that works over the Internet. An XML-RPC message is an HTTP-POST request. The body of the request is in XML. A procedure executes on the server and the value it returns is also formatted in XML. more information about XML/RPC

Header

POST /Xmlrpc/rpc HTTP/1.0
Host: www.photoxpress.com/Xmlrpc
Connection: close
Content-Type: text/xml
Content-Length: 569

Query Example

<?xml version="1.0" encoding="UTF-8"?>
<methodCall>
  <methodName>main.test</methodName>
  <params>
    <param>
      <value>
        <string>YOUR_API_KEY</string>
      </value>
    </param>
  </params>
</methodCall>

Response Example

<?xml version="1.0" encoding="UTF-8"?>
<methodResponse>
  <params>
    <param>
      <value>
        <string>OK</string>
      </value>
    </param>
  </params>
</methodResponse>