You are here

Getting started with APIs

Find out about using Aconex data to integrate enterprise software applications or develop third party applications.

With Aconex APIs you can:

  • Integrate Aconex with other software applications such as EDMS, internal mail systems and more
  • Improve data quality and consistency
  • Reduce manual errors and increase efficiencies
  • Extract project information for data mining or reporting
  • Extract and archive project information

Introduction to Aconex Web Services APIs 

This developer's guide provides comprehensive information about Aconex web services for developers looking to integrate enterprise software applications or develop third party applications that make use of the data residing within Aconex. 

Technology 

Aconex web services are designed to be programming language and platform independent and use a RESTful implementation with common standards such as HTTPS, URL and XML. At a minimum, developers wanting to make use of Aconex web services should be familiar with the following technologies/concepts: 

REST Interface 

Aconex web services are based on the concept of REST (Representational State Transfer). To access the services, requests that comply with the HTTPS standard must be constructed and make use of REST principles.

XML 

Aconex web services currently return all responses in XML format, except for the OAuth Services which returns responses in JSON. 

Security 

Aconex web services are designed to be entirely stateless, meaning the caller must provide valid user credentials as part of every request. The authenticating user's account must be active, and the user must have access to the relevant project. All requests must also be over HTTPS on port 443. Any requests which are not performed over an encrypted channel will be rejected. 

Currently two types of authentication are supported: 

  • Basic Authentication 
  • OAuth2 

Note: For user accounts having enabled SSO (Single Sign On) or 2SV (Two Step Verification), only the OAuth2 can be used.   

Basic Authentication 

The username and password is to be provided in the request using Basic Authentication principles.

Authorization: Basic BASE_64_ENCODED_USERNAME_AND_PASSWORD  

Sample request header: 

  • Authorization: Basic cG9sZWFyeTpBdXRoM250MWM= 

Below is an example using curl (a command line based Unix tool to perform web requests) to perform a mail search on the inbox of a project: 

  • curl -u user:password https://{hostname}/api/projects/{projectid}/mail?mail_box=inbox 

Here, username and password refer to the username and password used to logon to Aconex. Using standard clients such as curl, wget (or any programming library) will usually encode the username/password automatically using base64 encoding.

Was this article helpful?

Thanks. A ticket has been opened with the Support Central team.