Licence type

Price category

Model Release


Advanced Search

Delete cart

Do you really want to delete the cart?



Zoonar API Network – Documentation


With the Zoonar Application Programming Interface (Zoonar API Network) businesses can get automated access to our image portfolio. You can search for images, get detailed information on images and you can even download full resolution images.

Please note that you need an API Key and a password to use our Zoonar API Network. You are welcome to contact us to get access and a few simple usage examples.

Specific technical notes:

  • The Zoonar API utilizes the JSON format to output data..
  • All input data and return values must be encoded in UTF-8.

Method calls


getSearchResults


Executes a search query and returns the result.

Parameter

Argument Type Description
api_key string Your personal API-Key
words string The search string
offset int Start position in query
limit int total number of result

Return values

A JSON-encoded string, which contains the following values:
Argument Type Description
nb_results int Total number of result
resultset[n]->id int The unique Zoonar Image-ID
resultset[n]->title string Image Title
resultset[n]->image_width int Width of the original image in pixels
resultset[n]->image_height int Height of the original image in pixels
resultset[n]->model_release_status_id int Model-Release Status
1015: available, 1016: NOT available, 1017: not necessary
resultset[n]->model_release_status_msg string Model-Release identifier
resultset[n]->property_release_status_id int Property-Release Status
1040: available, 1041: NOT available, 1042: not necessary
resultset[n]->property_release_status_msg string Property-Release identifier
resultset[n]->thumbnail_url string Thumbnail URL

Example:
https://www.zoonar.com/api/getSearchResults?api_key=(api_key)&words=animal&limit=50&offset=0

getMediaData


Gives detail information to a specific image.

Parameter

Argument Type Description
api_key string Your personal API-Key
image_id int The unique Zoonar Image-ID

Return values

A JSON-encoded string, which contains the following values:
Argument Type Description
id int The unique Zoonar Image-ID
title string Image title
description string Image detailtext
copyright string Copyright information
model_release_status_id int Model-release Status
1015: available, 1016: NOT available, 1017: not necessary
model_release_status_msg string Model-Release identifier
property_release_status_id int Property-Release Status
1040: available, 1041: NOT available, 1042: not necessary
property_release_status_msg string Property-Release identifier
licence string License Information (RM or RF)
keywords[n] string Image keywords
licence_details[n]->id int Unique License-ID
licence_details[n]->name string License name (e.g. Original, Internet, DIN A4,...)
licence_details[n]->phrase string Format Description
licence_details[n]->filesize string Image file size in MB
licence_details[n]->price string License price in EUR
thumbnail_url string Preview image with watermark

Example:
https://www.zoonar.com/api/getMediaData?api_key=(api_key)&image_id=1

login


Login to the Zoonar API Network to get an authenticated session id.

Parameter

Argument Type Description
api_key string Your personal API-Key
user string Your API-Username
pass string Your API-Password

Return values

A JSON-encoded string, which contains the following values:
Argument Type Description
session_id string A valid Session-ID

Note:
For security reasons login has to be implemented as a POST-Request.

logout


Logout from Zoonar API Network. Existing sessions will expire.

Parameter

Argument Type Description
api_key string Your personal API-Key

Return values

A JSON-encoded string, which contains the following values:
Argument Type Description
logout string Logout-message, e.g: SUCCESS

Example:
https://www.zoonar.com/api/logout?api_key=(api_key)

getMedia


Image purchase and download ( needs authentication ).

Parameter

Argument Type Description
api_key string Your personal API-Key
session_id string Authenticated session id (see login-method)
image_id int The unique Zoonar Image-ID
licence_id int Licence-ID (see getMediaData-method)
price double Selling price or provision. E.g.: 20.5

Return values

A JSON-encoded string, which contains the following values:
Argument Type Description
download_url string Download-URL of the current image

Note:
For security reasons getMedia has to be implemented as a POST-Request.