🔌 API Integration
Optiply offers a public Application Programming Interface (API) that allows you to seamlessly integrate our forecasting and purchasing tool into your own software landscape.
The API is fully capable of reading, creating, and updating resources, giving you flexibility in how you manage your data flow.
Documentation and Guides
We provide comprehensive resources to help developers build and maintain the integration:
Public API Documentation: This technical reference details the endpoints available to read, create, update, and delete resources. It serves as the primary manual for your development team. [Link to API Documentation]
Requirements Document: This guide outlines the essential "Do's and Don'ts," functional requirements, and step-by-step instructions for setting up the integration correctly.
Prerequisites for a Successful Integration
Before connecting your system, it is critical that the data in your source system is clean and complete. Optiply relies on this data to generate accurate advice.
Please ensure the following:
Supplier Links: Every product must be linked to at least one Supplier.
Pricing: Every product must have a valid Purchase Price and Sales Price.
Inventory: Your Stock Levels must be accurate and up to date.
Open Orders: All Purchase Orders that have been placed but not yet delivered must be recorded in the system (to calculate accurate "Incoming Stock").
Sending Emails via Optiply
If you intend to send purchase orders directly from Optiply to your suppliers via email, this requires a specific configuration on our end.
Action Required: Please notify our support or integration team if you want to enable email sending so we can configure the correct SMTP or sender settings for your account.
Support
If you have specific technical questions or need assistance during the setup process, please feel free to contact our integration team at integrations@optiply.nl
❓ Frequently Asked Questions (FAQs)
Where do I find my API Key?
You can typically generate or retrieve your API credentials within the Optiply settings under the Integrations or Account tab. If you cannot find this section, please contact support to have API access enabled for your account.
Why are my products not appearing after an API sync?
The most common reason is missing data. As mentioned in the prerequisites, if a product does not have a linked Supplier or valid Prices, Optiply may reject the record to prevent calculation errors. Check your source data and try again.
Is the API connection real-time?
This depends on how you build your integration. You can trigger updates via the API as often as you like (e.g., every time a sale happens), but most integrations are set up to push data in batches (e.g., once per hour) to manage server load.
Can I use the API to delete products?
Yes, the API supports deletion. However, be careful: deleting a product via the API removes its history and forecast from Optiply. If you just want to stop ordering it, it is often safer to update its status to "Phased Out" rather than deleting it entirely.