Client Feed Queue Endpoint
Endpoint: https://api.hootinteractive.net/cli_api/feed/queue/<feed_request_id>
Security: HTTPS Basic Auth
User: <client_id>
Pass: <token>
Allowed Calls:
GET: Obtains status of the client feed request.
Params:
id: ID of the feed request to obtain info from. Example: https://api.hootinteractive.net/cli_api/feed/queue/1
Responses:
500 + Error message in case of error
404 If feed request id does not exist
200 OK + Feed request status
DELETE: Deletes the feed request:
Params:
id: ID of the feed request to delete. Example: https://api.hootinteractive.net/cli_api/feed/queue/1
Responses:
500 + Error message in case of error
404 If feed request id does not exist
200 OK
POST: Creates a feed request:
Request Body:
Responses:
500 + Error message in case of error
404 If feed type is not supported
200 OK
Feed Request Status Object
{
"id":1, # ID of feed Request
"created": "2021-12-25 00:00:00", # Creation date of the request
"updated": "2021-12-25 00:00:00", # Last update date of the request
"client_id":1, # Target client of the feed
"feed":"sold", # Feed type: ["sold","inventory"]
"date":"2021-15-25", # Date target of the feed
"status":"queued", # Status : ["queued","running", "error", "ready"]
"error":null # Error message if something went wrong when creating the feed
}
Edit
Client Feed Download
Endpoint: https://api.hootinteractive.net/cli_api/download/<client_feed_id>
Method: GET
Security: HTTPS Basic Auth
User: <client_id>
Pass: <token>
Responses:
500 + Error message in case of error
404 if the feed is not ready or does not exist
200 OK + feed file