APIs
An API (Application Programming Interface) is a set of rules and protocols that allow one software application to communicate with another. They define the methods and data formats that applications can use to request and exchange information. APIs can be classified according to the access they provide. An API with read-only access allows one system to retrieve data from another system without making any modifications, meaning it can only view or query the information. In contrast, an API with read and write access enables one system to both retrieve data and make changes, such as creating, updating, or deleting the data on the other system, allowing for more dynamic interactions.
Patheon offers two optional, add-on API features: a read-only data API feature and a read/write transactional API feature. Both work with any application/service capable of making REST (representational state transfer) API calls. REST is an architectural style for an application programming interface that uses HTTP requests to access and use data.
- Data API: Connect Patheon to third-party accounting systems, data warehousing systems, and/or custom reporting and dashboards. See below for more information.
- Transactional API: Connect Patheon to third-party ecommerce platforms (websites and mobile apps), loyalty and rewards programs, consumer portal systems, and/or marketing automation service providers. See below for more information.
- Leverage both API features for a complete, custom solution.
Get Started
Existing Patheon users interested in the data API feature, transactional API feature, or both, can begin the enrollment process (or request a demo (data evaluation) before committing to purchase) by contacting their sales representative.
FAQs
- Are the API features included as part of a standard system?Are the API features included as part of a standard system?
No. Each API feature is a separate, add-on monthly subscription.
- How much do the API features cost?How much do the API features cost?
Each API feature requires a one-time setup fee and a monthly recurring charge based on the number of sites in your organization. The monthly subscription must be paid in advance.
- Can an organization purchase only one of the API features?Can an organization purchase only one of the API features?
Yes. An organization can choose to purchase only the data API feature, or only the transactional API feature. Organizations do not need to purchase both API features.
- Is the cost greater if I use one of the API features for multiple connections, such as a data warehouse and an accounting solution?Is the cost greater if I use one of the API features for multiple connections, such as a data warehouse and an accounting solution?
No. The only limit is the number of calls (requests for data) that can be made.
- Are there limits on the number of calls (requests for data) that can be made?Are there limits on the number of calls (requests for data) that can be made?
Yes. Each API feature has a limit of 60 calls per minute - in other words, 1 per second.
- Does DRB support third-party API connection services or systems?Does DRB support third-party API connection services or systems?
No. DRB does not offer technical support or troubleshooting for third-party services or systems. However, DRB can verify the API is configured correctly and sending/receiving data.
- Can DRB figure out why the third-party product/system my data API connects to isn't receiving data?Can DRB figure out why the third-party product/system my data API connects to isn't receiving data?
DRB staff can verify your data API is able to send data. However, DRB does not support third-party products and solutions. Contact the third-party product/solution provider to determine the reason they aren't receiving data.
- Does the transactional API provide access to all transactions?Does the transactional API provide access to all transactions?
No. The transactional API only pulls the 50 most recent transactions. For a comprehensive transaction history, organizations should purchase both the data API feature and the transactional API feature.
- Does either API provide access to the entire Patheon database?Does either API provide access to the entire Patheon database?
No. Contact a DRB sales representative and request a data evaluation for more information on the data that is available with each API.
Data API
With the Patheon data API feature's read capability, Patheon users can customize and streamline some of their most important tasks related to financial tracking, data backups, and reporting.
- Connect with third-party enterprise accounting systems
- Warehouse data in third-party external data storage systems
- Develop custom reporting with third-party business intelligence solutions
The Patheon data API feature provides read-only access. It does not provide the ability to update, delete, or insert data.
Enterprise Accounting
Use the data API feature to integrate your Patheon system with a third-party accounting solution. The following third-party accounting solutions represent just a few such solutions that support REST API integrations. DRB does not endorse or provide technical support for any third-party solution.
- Oracle NetSuite
- QuickBooks Online
- Sage Intacct
External Data Storage
Use the data API feature to store historical sales data from your Patheon system with a third-party data warehousing solution. The following third-party data warehousing solutions represent just a few such solutions that support REST API integrations. DRB does not endorse or provide technical support for any third-party solution.
- MongoDB
- Snowflake
Custom Dashboards + Reporting
Use the data API feature to build custom dashboards and reporting for your Patheon system with a third-party business intelligence solution. The following third-party reporting solutions represent just a few such solutions that support REST API integrations. DRB does not endorse or provide technical support for any third-party solution.
- Power BI
- Tableau
Transactional API
With the Patheon transactional API feature's read/write capabilities, Patheon users can create a personalized consumer journey, through ecommerce, loyalty programs, profile portals, and marketing automation.
- eCommerce Integrations: Allows operators to create their own eCommerce experiences, add Patheon products/washes to existing eCommerce or leverage third-party options to provide complete control over online sales processes
- Loyalty & Rewards Program Integrations: Supports the integration of custom loyalty programs, allowing consumers to earn and/or redeem rewards through car washes’ existing or preferred loyalty programs (fuel service stations, grocery stores, etc.)
- Consumer Portal Integrations: Leverage existing or third-party consumer management portals that allow consumers to update or manage their accounts, view transaction histories, and more
- Marketing Automation Integrations: Integrate point-of-sale data with third-party marketing automation platforms to run campaigns
The Patheon transactional API feature provides read and write access.
eCommerce
Third-party website development and ecommerce platforms can integrate with Patheon through its transactional API feature, allowing consumers to update or manage their accounts, view transaction histories, or make new purchases. DRB does not endorse or provide technical support for any third-party solution.
Loyalty & Rewards Programs
Third-party loyalty and rewards programs not only enhance customer engagement, but also provide opportunities for wash operators to create applications that leverage rewards data through the Patheon transactional API feature. DRB does not endorse or provide technical support for any third-party solution.
Consumer Portal
Third-party customer portal service platforms allow businesses to integrate their services and enhance customer interaction through the Patheon transactional API feature. DRB does not endorse or provide technical support for any third-party solution.
Marketing Automation
Integrate Patheon data with third-party marketing automation platforms to engage consumers and increase traffic through the Patheon transactional API feature. DRB does not endorse or provide technical support for any third-party solution.