+1 (888) 674-2299

32,869,213 Royalty Free Stock Photos

How to use the Fotolia API

API Key

To use the API to query Fotolia's database, you must first obtain an API key. API keys can be obtained from the “Toolbox” section of your account and completing the API form. Three kinds of API keys are available: Partner API keys, Developer API keys, and Business API keys. Please see the chart below to review the features of each API key. You may obtain multiple API keys simply by applying for different keys.

Terms of Use

The API Terms of Use governs the rights and conditions in which each API may be used. Please review the API Terms of Use for the appropriate API before using it.

Encoding

The Fotolia API requires that all data to be UTF-8 encoded. More information about UTF-8 encoding

Authentication

Some methods need to be authenticated (see table below). Authentication is only available for the Developer and Business APIs. The process of authentication is equivalent to login process of the Fotolia website. The login and password must be sent securely through the API and when authenticated a session ID is provided. This session ID will then be needed to use methods with authentication. For more information about authentication, please see loginUser method.

API Calls Quota

Fotolia limits the number of API calls by default to 500 per hour and 10,000 per day.
If you expect traffic to be higher, please contact support.

Methods

Methods make it possible to execute different functions through the API. The following table has information about the methods available within each API Type.

Methods Partner API Business API Developer API Reseller API Authentication Description
Search
getSearchResults Authorized Authorized Authorized Authorized no full search capabilities
getCategories1 Authorized Authorized Authorized Authorized no return representative categories
getCategories2 Authorized Authorized Authorized Authorized no return conceptual categories
getTags Authorized Authorized Authorized Authorized no return tag cloud
getGalleries Authorized Authorized Authorized Authorized no return public galleries
getSeasonalGalleries Authorized Authorized Authorized Authorized no return seasonal galleries
getCountries Authorized Authorized Authorized Authorized no return countries list
Media
getMediaData Authorized Authorized Authorized Authorized no return all information about a media
getBulkMediaData Authorized Authorized Authorized Authorized no return all information about one or more media
getMediaGalleries Authorized Authorized Authorized Authorized no return galleries attached to a media
getMedia Prohibited Authorized Prohibited Authorized yes return download link (media purchase)
getMediaComp Authorized Authorized Authorized Authorized no return url of the comp image
getHomePageImages Authorized Authorized Authorized Authorized Non return images features on the homepage
User
loginUser Authorized Authorized Authorized Authorized no log a user (needed for authentification)
refreshToken Authorized Authorized Authorized Authorized no Renew authentication token
userSignUp Authorized Authorized Authorized Authorized no Create a new Fotolia user
userEditProfile Authorized Authorized Authorized Authorized yes Update the profile of a Fotolia's member
getUserData Authorized Authorized Authorized Authorized yes return information about the logged user
getSalesData Authorized Authorized Authorized Authorized yes return sales data of the logged in user
getUserStats Authorized Authorized Authorized Authorized yes return account statistics of the logged user
getUserGalleries Authorized Authorized Authorized Authorized yes return galleries of the logged user
getUserGalleryMedias Authorized Authorized Authorized Authorized yes return the lightbox/gallery content of a logged user
deleteUserGallery Authorized Authorized Authorized Authorized yes Delete a gallery from the logged user
createUserGallery Authorized Authorized Authorized Authorized yes create a new gallery for the logged user
addToUserGallery Authorized Authorized Authorized Authorized yes add a content to a gallery of the logged user
removeFromUserGallery Authorized Authorized Authorized Authorized yes remove a content from a galley of the logged user
user.moveUpMediaInUserGallery Authorized Authorized Authorized Authorized yes move up a media in an user galleryr
user.moveDownMediaInUserGallery Authorized Authorized Authorized Authorized yes move down a media in an user gallery
user.moveMediaToTopInUserGallery Authorized Authorized Authorized Authorized yes move a media to top position in an user gallery
getUserAdvancedStats Authorized Authorized Authorized Authorized yes return advanced account statistics of the logged user
getLastOnlineContents Authorized Authorized Authorized Authorized Oui Return last online files of the current user
getUploadFolders Authorized Authorized Authorized Authorized Oui Return the upload folders list of the authenticated contributor
getUploadFolderFileIds Authorized Authorized Authorized Authorized Yes return file IDs inside an upload folder
uploadIdCard Authorized Authorized Authorized Authorized Yes Upload a new contributor ID card
uploadIdCard Authorized Authorized Authorized Authorized Yes Upload a new contributor ID card
upload Authorized Authorized Authorized Authorized Yes Upload a new file into user's account
getLastUploadedMedia Authorized Authorized Authorized Authorized Yes List the uploads made the last 7 days
Shopping cart
shoppingcart.getList Prohibited Authorized Prohibited Authorized yes Returns shopping cart content
shoppingcart.add Prohibited Authorized Prohibited Authorized yes Add a media to the user's shopping cart
shoppingcart.update Prohibited Authorized Prohibited Authorized yes Update a media into the user's shopping cart
shoppingcart.remove Prohibited Authorized Prohibited Authorized yes Remove a media from the user's shopping cart
shoppingcart.transferToLightbox Prohibited Authorized Prohibited Authorized yes Remove a media from the user's shopping cart and add to to his lightbox
shoppingcart.clear Prohibited Authorized Prohibited Authorized yes Clear the user's shopping cart
Main
getData Authorized Authorized Authorized Authorized no retun general information about Fotolia
test Authorized Authorized Authorized Authorized no return success
Reseller API
user.subaccount.getIds Prohibited Prohibited Prohibited Authorized no Returns an array of all available subaccount IDs
user.subaccount.create Prohibited Prohibited Prohibited Authorized no Create a reseller subaccount
user.subaccount.delete Prohibited Prohibited Prohibited Authorized no Delete a reseller subaccount
user.subaccount.edit Prohibited Prohibited Prohibited Authorized no Update data of a reseller subaccount
user.subaccount.get Prohibited Prohibited Prohibited Authorized no Get reseller subaccount details
user.subaccount.getPurchasedContents Prohibited Prohibited Prohibited Authorized no Get the list of purchases made by a subaccount
media.getLicense Prohibited Prohibited Prohibited Authorized no Get the licence between the reseller and his customer for a specific sale.

Query Format

HTTP

The Fotolia API is a REST API, available via standard HTTP calls, using the method GET for read-only methods, the method POST for methods that modify data or log the user in, and the standard query string to pass arguments.
More information about REST.

To use the REST API, each request must be sent using your API key as the HTTP username, and either an empty string (for public methods) or a session token (for methods that require authentication) as the HTTP password.

Base URL

The base URL for the REST API is: https://api.fotolia.com/Rest/1/

Return format

The data returned by the REST API is formatted in JSON, a format that can be parsed with most modern programming languages.
More information about JSON.

Query Example

In this example, we call the method main/test with the API key 'exampleApiKey' as the HTTP username, and an empty HTTP password since the method is public. The authorization header thus uses the base64 encoded string 'exampleApiKey:'.

GET /Rest/1/main/test HTTP/1.0
Host: api.fotolia.com
Authorization: Basic ZXhhbXBsZUFwaUtleTo=

Methods that are called using GET may also be called directly by URL, so URL in this example would be: https://exampleApiKey:@api.fotolia.com/Rest/1/main/test

Response Example

{
    "test":"Success"
}

API Kits

You can use a kit in order to help simplify API use. A list of kits available is listed below. Please contact us to have your kit listed.

PHP, Java and Python