Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

The Compliance Workbook offers an HTTP API for integration with third party systems. The API enables you to submit PDF documents for processing, view the compliance of submitted documents, as well as browse a list of the properties on your account. You can view the Swagger page for the API at https://api.thecomplianceworkbook.com/swagger/ui/index#/.

Integrating With The API

To get started with the API, you must have a valid Username and API Key. If you do not have one or either of these, please raise a support desk ticket.

API Architecture

The API is divided into three key areas:

  • Documents - API routes with a URL of /documents provide interactions with documents on your account.
  • Properties - API routes with a URL of /properties provide interactions with properties on your account.
  • Callbacks - API routes with a URL of /callback provide interactions with your IT systems to receive notifications of document processing.

Typical User Interactions

To assist with the below use cases, we have created a Postman collection. Please set your Username, Password and Document Id variables in the collection to use the sample requests.


Document Submission

The typical user journey for document submission is as follows:

  1. PDF document submitted to the API. Documents can be submitted for processing by issuing a HTTP POST request to https://api.thecomplianceworkbook.com/api/documents. Please refer to Document Creation Postman request for full details of the parameters.
  2. A Document Id is returned from this HTTP request.
  3. The status of this document is polled by issuing HTTP GET requests to https://api.thecomplianceworkbook.com/api/documents/{documentId}. Please refer to the Document Details Postman request for full details of the parameters.
  4. The Status property of response will indicate whether the document has been successfully processed.
    1. A value of Pending indicates further processing is ongoing.
    2. A value of Completed indicates all processing is complete.

Document Details

A summary of all the documents on your account can be accessed by a HTTP GET request to /api/documents. Please refer to the Documents Summary Postman request for a working example.

The Document Id returned from the HTTP POST to /api/documents can be used to retrieve various data sets extracted from your PDF

  • Summary of the document.
  • Compliance and associated compliance calculations.
  • Data fields extracted from the PDF.
  • Tags attached to the document, for example the name of the engineer.

Properties

Data about properties on your account can be accessed by HTTP GET requests to /api/properties/{propertyId}. Please refer to the Properties Summary Postman request for a working example.

Callbacks

Callbacks can be used to allow our API to notify your IT systems when we have completed processing a submitted PDF. With help setting up callbacks, please contact us directly.


  • No labels