Zoonar API Network – Dokumentation


Mithilfe der Zoonar Programmierschnittstelle (Zoonar API Network) haben Unternehmen die Möglichkeit, automatisiert auf unseren Bildbestand zuzugreifen. Sie können Bilder suchen, Detailinformationen zu Bildern abfragen und sogar Feindaten laden.

Beachten Sie bitte, dass Sie zur Verwendung des Zoonar API Network einen API-Key und Passwort benötigen. Schreiben Sie uns gerne eine Nachricht, um einen Zugang und einige einfache Beispiele zur Anbindung zu erhalten.

Besonderheiten zur Nutzung:

  • Jegliche Rückgaben der Zoonar API erfolgen im JSON Format.
  • Die Daten und Rückgabewerte müssen UTF-8 kodiert sein.

Methodenaufrufe


getSearchResults


Führt eine Suche auf den Bildbestand aus und gibt die Treffer zurück.

Parameter

Feld Typ Beschreibung
api_key string Ihr persönlicher API-Key
words string Der Suchbegriff
offset int Startposition der Suche
limit int max. Anzahl der Treffer

Rückgabe

JSON-kodierte Rückgabe mit den Werten:
Feld Typ Beschreibung
nb_results int Anzahl der Treffer
resultset[n]->id int Eindeutige Zoonar Bild-ID
resultset[n]->title string Bild-Titel
resultset[n]->image_width int Breitenangabe des Originalbildes in Pixel
resultset[n]->image_height int Höhenangabe des Originalbildes in Pixel
resultset[n]->model_release_status_id int Angaben zum Model-Release Status
1015: liegt vor, 1016: liegt NICHT vor, 1017: nicht nötig
resultset[n]->model_release_status_msg string Hinweis zum Model-Release Status
resultset[n]->property_release_status_id int Angaben zum Property-Release Status
1040: liegt vor, 1041: liegt NICHT vor, 1042: nicht nötig
resultset[n]->property_release_status_msg string Hinweis zum Property-Release Status
resultset[n]->thumbnail_url string Thumbnail URL

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

getMediaData


Liefert Detailangaben zu einem bestimmten Bild.

Parameter

Feld Typ Beschreibung
api_key string Ihr persönlicher API-Key
image_id int Eindeutige Zoonar Bild-ID

Rückgabe

JSON-kodierte Rückgabe mit den Werten:
Feld Typ Beschreibung
id int Eindeutige Zoonar Bild-ID
title string Bild-Titel
description string Bild Detailtext
copyright string Hinweise zum Copyright
model_release_status_id int Angaben zum Model-Release Status
1015: liegt vor, 1016: liegt NICHT vor, 1017: nicht nötig
model_release_status_msg string Hinweis zum Model-Release Status
property_release_status_id int Angaben zum Property-Release Status
1040: liegt vor, 1041: liegt NICHT vor, 1042: nicht nötig
property_release_status_msg string Hinweis zum Property-Release Status
licence string Hinweis zur Lizenz (RM oder RF)
keywords[n] string Schlagwörter zum Bild
licence_details[n]->id int Eindeutige Lizenz-ID
licence_details[n]->name string Name der Lizenz (z.B. Original, Internet, DIN A4, usw.)
licence_details[n]->phrase string Format Beschreibung
licence_details[n]->filesize string Größe der Datei in MB
licence_details[n]->price string Preis der Lizenz in EUR
thumbnail_url string Vorschau URL inkl. Wasserzeichen

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

login


Login in das Zoonar API Network, um eine authentifizierte Session-ID zu erhalten.

Parameter

Feld Typ Beschreibung
api_key string Ihr persönlicher API-Key
user string Ihr API-Benutzername
pass string Ihr API-Passwort

Rückgabe

JSON-kodierte Rückgabe mit den Werten:
Feld Typ Beschreibung
session_id string Eine gültige Session-ID zur Weiterverwertung

Hinweis:
Aus Sicherheitsgründen darf die login-Methode ausschließlich als POST-Request implementiert werden.

logout


Logout aus dem Zoonar API Network. Bestehende Sessions werden damit ungültig.

Parameter

Feld Typ Beschreibung
api_key string Ihr persönlicher API-Key

Rückgabe

JSON-kodierte Rückgabe mit den Werten:
Feld Typ Beschreibung
logout string Logout-Meldung, z.B: SUCCESS

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

getMedia


Kauf und Download einer Bild-Lizenz (erfordert Authentifizierung).

Parameter

Feld Typ Beschreibung
api_key string Ihr persönlicher API-Key
session_id string Authentifizierte Session-ID (siehe login-Methode)
image_id int Eindeutige Zoonar Bild-ID
licence_id int Lizenz-ID (siehe getMediaData-Methode)
price double Verkaufspreis oder Provision. Beispiel: 20.5

Rückgabe

JSON-kodierte Rückgabe mit den Werten:
Feld Typ Beschreibung
download_url string Download-URL zum gewählten Bild

Hinweis:
Aus Sicherheitsgründen darf die getMedia-Methode ausschließlich als POST-Request implementiert werden.