Skip to main content
All CollectionsResources for admins
API: Integrate with Guidewheel
API: Integrate with Guidewheel

Overview of Guidewheel’s API capabilities

Tania Siska avatar
Written by Tania Siska
Updated over a week ago

The Guidewheel system is built for secure and easy connection to other systems and applications. We offer both inbound and outbound APIs to make those connections straightforward.

API Overview

Guidewheel’s cloud-hosted infrastructure is designed and managed in alignment with the best practices of multiple IT security standards. As with every aspect of our system, our API is designed for secure and straightforward connection in alignment with best practices.

API Framework and Endpoints

Guidewheel has created a RESTFUL (HTTPS) API built on the Nest.js framework. This allows our customers to create a web service that interacts with the Guidewheel endpoints so data can be posted and also pulled from the Guidewheel database. The Guidewheel API is based on the JSON industry standard and will work with any system.

We have both POST APIs (CSV or JSON) and GET APIs (JSON) available.

API Compatibility

Guidewheel’s API is compatible with any system built using software best practices. For example, it works well with SAP, Oracle, Epicor and/or other ERP or MES systems.

API Security

In addition to the best practices used to secure our infrastructure, the API is secured in three ways:

  1. Documentation is password protected

  2. Each customer has a unique API key that only allows them access to their information

  3. All transactions are handled via HTTPS

For additional information on Guidewheel’s API or other aspects, contact [email protected]

Did this answer your question?