The InkyBay Shopify Order SDK enables merchants to securely receive and store all custom order files generated by the InkyBay Product Personalizer app. This SDK is installed on your own server and automatically fetches design files, order data, and related assets once a customized order is placed in your Shopify store.
Before setting up the SDK, please ensure:
- PHP is installed and properly configured on your server
- Your server is publicly accessible via HTTPS
Navigate to:
InkyBay Admin → Settings → Add-Ons → Order Batch Download & Exporter → Settings
- Activate the API to generate your Access Key and Secret Key
- Configure the Hook URL, which is the endpoint on your server where InkyBay will send the
orderIdanditemIdafter order processing is completed
- Open the
conf.phpfile - Set your credentials:
- Replace
__ACCESS_KEY__with your Access Key - Replace
__SECRET_KEY__with your Secret Key
- Replace
Upload the SDK to your server and copy the SDK URL.
Then update the hook URL in:
InkyBay Admin → Settings → Add-Ons → Order Item Hook URL
- If your server automatically routes to
index.php, no additional configuration is required - Otherwise, append
/item.phpto the hook URL, for example:
https://your-server-domain/sdk-folder/item.php
After updating the hook URL:
- Click the Test Hook button
- Verify that order data and files are successfully created inside the
ordersdirectory
Make sure the orders folder is writable by the PHP runtime. You may extend or modify the SDK to collect additional order-related information.
Refer to the sample implementation:
- This SDK is intended only for Shopify merchants who have installed the
InkyBay Product Personalizerapp - Ensure proper server security practices when handling order data
- Ensure your orders folder has write permission for PHP
© InkyBay®, Powered by - ParseLab, LLC