API overview

The 3d Signals platform lets you connect with our cloud-based product for real time manufacturing data, in a secured and authorized way.
Access to such data will enhance data-driven decision-making and improve planning and production processes through actionable insights. 
Keep reading to get an overview of our platform’s features. We will outline some examples of how 3d Signals’ customers use our platform’s APIs.

What can the 3d Signals platform do?

The 3d Signals platform offers different interfaces to consume and update your enterprise software and external tools, such as BI tools. 

3d Signals allows developers to interact with its cloud via Representational State Transfer (REST) standard API.
Different APIs can be used for different types of interaction with the platform. You can use them on their own or include them in your code to be embedded in your application.

3d Signals APIs

There are many third-party client libraries that can be used to verify REST APIs before the implementation of your own client application. We recommend starting with Postman.
In order to enable developers to access the data without compromising user privacy and security, the access is secured by HTTPS protocol and requires a username and a password provided by the 3d Signals team.
The URL path will always begin with: https://developers.3dsignals.io/api/v1/
Note: In order to interact with the 3d Signals cloud, a client application needs to be set up.

API TokenTo prevent unauthorized or unauthenticated users from accessing the data, every interaction with the 3d Signals API must contain an API Token
Machine infoProvides unique machine IDs. The unique IDs have to be used to retrieve/submit information about specific machines
Machine ordersUpdate work orders list for one or more machines
Machine statusGet the current state and state duration of a specific machine by providing the machine Id
Machine activity logGet the machine activity data for a specific machine in a time frame
Machine state reasonClassify a specific reason for a machine state, over a  period of time
Work order dataUpdate work order’s master data and PDA data for work order tracking

Using the 3d Signals service

Permissions and authorization

All of our communications are secured and follow industry-standard authentication protocol. To learn how to authorize a connection to the 3d Signals API, see Authorization Overview.

Data Rate Limits

Products that make a large number of requests in a given period of time can impact the service. In order to enable a compelling user experience, without compromising the service availability, we apply rate limits. Rate limiting restricts the number of API calls for a given time period. Currently, the limitation is set to 10 requests per minute.

HTTP Methods

The supported HTTP method types are:

  • GET
  • POST
  • PUT

Content-Type

The service supports the payload type of application/JSON (JavaScript Object Notation). To validate the JSON structure, we recommend using a JSON validator.

Date and Time format

To prevent time zone bias and for accuracy sake, the service uses UNIX time as the date and time format. We recommend using the following timestamp converter.