Custom Orders Report API
An API (Application Programming Interface) is automatically generated for each custom report, allowing you to automatically pull data into your own application or other database. An API allows your developer to automatically pull your custom orders report data from GiftTool to your application with this secure API URL.
To access the Custom Orders Report API:
- Click the Account link located in the top right corner of your GiftTool BackOffice account.
- Click Custom Report.
- Click API next to the Custom Orders report previously created, or create a new Custom Orders report.
- Copy the API URL and paste it into your custom application.
- Follow these developer notes when using the API:
- You must connect securely to this API with https
- The parameter name ID is your GiftTool account ID.
- The parameter name CORID is the Custom Orders Report ID.
- The parameter names StartDate and EndDate are the start date and end date for the report.
- Both dates are included in the report.
- All dates used are in the format YYYY-MM-DD.
- The security Token is now only available for a single use. After every use, you must increment the Timestamp then recalculated the security token. This change ensures the highest level of security when transmitting your data. The Timestamp must be a larger number on every use.
- The report API Password is configurable in the setup of the Custom Report, and must be unique for each report. Should the password change, your application must use the new security token generated with this password to access the report data.
- To disable an existing report API, simply change the API Password in the setup of the Custom Report.
New as of June 3, 2010
- The security token is now only available for a single use. After every use, you must increment the timestamp then recalculated the security token. The timestamp must be a larger number on every use.
- This change ensures the highest level of security when transmitting your data.
Was this information helpful?
|
|