Search this site

Overview

Contents

  1. 1 Welcome to the ProofHQ API
  2. 2 Supported formats
  3. 3 Getting started with the API
  4. 4 FAQ's

Welcome to the ProofHQ API

The ProofHQ API is a simple HTTP service that is secured using SSL. The API aims to provide you with all the functionality that used in our own application.

If you require help on the application functionality, please refer to the ProofHQ help pages.

Supported formats

The public interface is SOAP 1.1 compliant with WSDL support. All requests are therefore executed using XML over HTTPS.

Getting started with the API

The API entry point:
https://www.proofhq.com/soap
(please note the use of HTTPS) 


The WSDL can be found here:

https://www.proofhq.com/soap?wsdl


Every API request requires a session key. This session key identifies the ProofHQ user performing the action(s) and is obtained by calling the doLogin() method and passing in the user's email address and password. The doLogin() method only needs to be called once before a sequence of API requests. The session key remains active for a short period of time and is renewed on every method call. We will be adding support for token based authentication very soon.

All requests use the following envelope, header and body format:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:proofhqapi">
    <soapenv:Header/>
    <soapenv:Body>
        ... API function and data inserted here ...
    </soapenv:Body>
</soapenv:Envelope>

FAQ's

For a collection of frequently asked questions, please visit this page.