Dashpivot logo

Dashpivot Connect

Welcome to Dashpivot Connect. Here you’ll find comprehensive information and documentation to guide you through the process of building integrations with Dashpivot software. We’ve done our best to make it simple and easy to use our API.

Overview

What is Dashpivot Connect?

Dashpivot Connect provides the underlying platform architecture and open Application Programming Interface (API) used to develop applications and custom integrations between Dashpivot and other software tools and technologies. With Dashpivot Connect you can expand the functionality of your Dashpivot account by leveraging existing functionalities, or by developing new applications and customised connections yourself using the Dashpivot Connect API.

Dashpivot Connect API

If you intend to build your own applications (or hire someone to build them for you), the Dashpivot Connect API allows you to leverage Dashpivot resources in a simple, programmatic way using conventional HTTP requests in a RESTful architecture. The Dashpivot Connect API endpoints are intuitive and powerful, enabling you to easily make calls to retrieve information or execute actions on the various resources in Dashpivot.

Dashpivot API

Dashpivot Portal Overview

Custom Integrations

Integrate your existing best-in-class applications with Dashpivot to increase productivity, maximise the ROI of existing solutions, and extract valuable insights. In order to provide a superior solution for all aspects of construction management, Dashpivot Connect gives customers an integration toolkit and access to our public API to build custom integrations between Dashpivot and other technologies used within the customer’s organisations. We do understand you may want to extend Dashpivot by building a custom integration. With the Dashpivot Connect API, you are able to build custom integrations and tools for your team that will allow you maximise the value of Dashpivot for your business by increasing efficiency, cutting down on duplicate data entry, keeping your employees in their preferred software tool and more.

Dashpivot Connect enables many different integrations, including:

  • Integrations to Enterprise Applications
  • Custom Dashboards and Data Warehouses
  • Custom Reports
  • Custom Workflows

Docs and Reference

Clicking the Reference tab takes you to a comprehensive set of reference pages that cover all the available Dashpivot Connect API resources and endpoints. Each reference page describes a particular API call and it’s associated syntax rules. You’ll refer back to these pages regularly while you build out your integration. The material in the Reference section is conveniently searchable and easy to navigate.

RESTful API Concepts

Overview

Representational state transfer (REST) is a common architectural style used for web development. Systems and sites designed using this style aim for fast performance, reliability and the ability to scale easily.

Resources

The primary abstraction of information in a REST architecture is a resource. Any information that can be named can be a resource – a document or image, a service, a collection of other resources, and so on. Resources comprise data and functionality and are accessed using Uniform Resource Identifiers (URIs). Resources are acted upon by using a set of standard, well-defined operations. Clients and servers exchange representations of resources by using a standardized interface and protocol – typically HTTP.

HTTP Resource Methods

Another important characteristic of REST is the use of resource methods to perform a desired operation. Similar to other RESTful APIs, Dashpivot Connect API supports the following set of standard HTTP verbs as resource methods: GET, POST, PUT, DELETE

To learn more about HTTP verbs as RESTful methods, see HTTP Methods for RESTful Services.

API Requests

Requests

By default, all API requests expect input in application/json format where each request is allowed to contain parameters and other discretionary data types. All JSON requests must specify the object types that the payload is carrying. The format type, query parameters, and any other required fields are contained within the sample body request for each object as depicted in the following example.

Responses

All API call responses return the requested information in JSON format. Responses in XML format are currently not supported. The following example shows the response from the request shown here.

{
"kind": "form",
"appVersion": 5,
"formVersion": 1,
"name": "Shift Report",
"isInColmn": 1,
"expiresOn": "2018-01-18T09:04:51.215Z",
"counter": 2;
"counterIsActivated": false,
"createdBy": {
"firstName": "James",
"lastName": "Brookes",
"id": "593a077de9f1aa1ac83c7718"
}
"createdAt": "2017-06-09T02:27:09.458Z",
"updatedAt": "2017-09-13T09:05:32.315Z",
"id": "5a8a14675f04816dbef826f0"
}

Examples

Authentication

First you need to request a valid JWT token from the authentication endpoint (POST https://api.constructioncloud.io/v1/users/login/jwt) by providing a valid email address and password in JSON format in the POST payload. On successful authentication, the endpoint returns a JWT token in JSON format. This JWT token should be used as authentication key to access all other endpoints.

Request: POST https://api.constructioncloud.io/v1/users/login/jwt

Response: JSON object

{
"username": "user@company.com",
"password": "Yu89N7aZ0"
}

{
"token": "YOUR_TOKEN"
}

Request all Apps of a Team

This example shows how to request all apps existing within one team. The unique team identifier (teamID) is needed before making the API call. In our example the teamID is 593a077de9f1aa1ac83c770f

Request: GET https://api.constructioncloud.io/teams/593a077de9f1aa1ac83c770f/apps

Response: JSON array containing each app within the team. Figure below: example JSON object of an app without the app’s items.

{
"kind": "app",
"appVersion": 2,
"instanceName": "Instance",
"columns": [
"Project Engineer",
"Senior Project Engineer",
"Project Manager",
"Active",
"Archived"
],
"isInColumn": 1,
"expiresOn": "2017-06-09T02:27:09.458Z",
"counter": 0,
"counterIsActivated": false,
"archived": false;
"name": "Excavation Permit"
"createdBy": {
"firstName": "Jess",
"lastName": "McCormack",
"id": "593a077de9f1aa1ac83c7718",
},
"createdAt": "2017-06-09T02:27:09.458Z",
"updatedAt": "2017-09-13T09:05:32.315Z",
"uniqueAppId": "593a077de9f1aa1ac83c7bc7",
"id": "593a077de9f1aa1ac83c7bc7"
},

Request all Forms of a Template

This example shows how to request all forms within an app. The unique app identifier (appID) is needed before making the API call. In our example the appID is 59420f48ba5bc90b699d1ecd

Request: GET https://api.constructioncloud.io/apps/59420f48ba5bc90b699d1ecd/forms

Response: JSON array containing each form within the app. Figure below: example JSON object of a form without the form’s items.

{
"kind": "form",
"appVersion": 5,
"formVersion": 1,
"name": "Shift Report",
"isInColmn": 1,
"expiresOn": "2018-01-18T09:04:51.215Z",
"counter": 2;
"counterIsActivated": false,
"createdBy": {
"firstName": "James",
"lastName": "Brookes",
"id": "593a077de9f1aa1ac83c7718"
}
"createdAt": "2017-06-09T02:27:09.458Z",
"updatedAt": "2017-09-13T09:05:32.315Z",
"id": "5a8a14675f04816dbef826f0"
}

Hosting on AWS

Dashpivot is hosted on AWS

Dashpivot connect

Security and Availability

AWS Service Organization Control (SOC) Reports are independent third-party examination reports that demonstrate how AWS achieves key compliance controls and objectives.

SOC 2-3

Primary Report Purpose
To provide customers and users with a business need with an independent assessment of AWS’ control environment relevant to system security.

Under what Standard is the Audit Report Performed?
AICPA: AT 101, Attest Engagements
AICPA Technical Practice Aid: TSP Section 100

Audited data centers:
+35 on 6 continents, inclusive Sydney & Melbourne

API-Security-01-02

AWS is ISO 27001 certified

ISO 27001 is a security management standard that specifies security management best practices and comprehensive security controls following the ISO 27002 best practice guidance.

This certification requires AWS to:

  • Systematically evaluate information security risks, taking into account the impact of company threats and vulnerabilities
  • Design and implement a comprehensive suite of information security controls and other forms of risk management to address company and architecture security risks
  • Adopt an overarching management process to ensure that the information security controls meet the information security needs on an ongoing basis

Questions or concerns? Book some time on the Sitemate calendar.