This page explains the Fredhopper Services REST API.

Introduction

The Fredhopper Services REST API is an API to upload data, trigger operations, retrieve results, and monitor the status of your services. The API tries to follow the general principles for REST to minimize the learning effort.

• operations use the generic HTTP verbs "GET" for retrieving information, "POST" for submitting new information, and "PUT" for changing information
• operations use the generic HTTP result codes in accordance with their meaning: "200 OK" means a request has been processed, "404 Not Found" means information is not there, etc.
• content negotiation is used where applicable, and generally the content-type information is relevant
• all operations are intended to be primarily consumed by machines, without preventing access for humans

More information about REST can be found here:

• http://www.infoq.com/articles/rest-introduction
• http://www.ics.uci.edu/~fielding/pubs/dissertation/rest_arch_style.htm

The supported operations are detailed below, all of them are accessed via HTTPS requests to my.<region>.fredhopperservices.com.

Supported operations

This section summarizes the supported endpoints of the Fredhopper Services API.

Incremental updates

Incremental updates can be provided to the system by uploading data and manual triggering.

• PUT /{sin}/data/input/data-incremental.zip?checksum={checksum}
• PUT /{sin}/data/input/{id}/data-incremental.zip
• GET /{sin}/data/input/{id}/data-incremental.zip

Full load

• PUT /{sin}/data/input/data.zip?checksum={checksum}
• PUT /{sin}/data/input/{id}/data.zip
• GET /{sin}/data/input/{id}/data.zip

Triggering and Monitoring

• PUT /{sin}/trigger/{tn}
• PUT /{sin}/trigger/{tn}/{id}
• GET /{sin}/trigger/{tn}/{id}/status

Download of produced output

• GET /{sin}/data/output/{id}/{filename}
• GET /{sin}/data/output/latest/{filename}