Class: ImageApi

farmaframe. ImageApi

new ImageApi(options)

Represents access to the FarmaFrame api.
Parameters:
Name Type Description
options Object Options
Properties
Name Type Argument Default Description
apiKey string Your api key
clientKey string Your client key
language farmaframe.LANGUAGES Preferred content language
baseUrl string <optional>
https://api.farmaframe.be/v1/ Base url for the api.
Source:

Methods

<static> getImages(products) → {Deferred}

Returns the image listings for the specified products.
Parameters:
Name Type Description
products Array.<string> One or more product CNK codes.
Source:
Returns:
A jquery deferred response. Deffered.done({Array.ProductImages})
Type
Deferred

<static> getThumbnailUrl(product, size) → {string}

Returns a thumbnail url. This does not perform an API call.
Parameters:
Name Type Description
product string The product CNK-code.
size farmaframe.THUMBNAIL_SIZES Preferred dimensions of the image.
Source:
Returns:
The url to a thumbnail.
Type
string