Getty Images API Java SDK

Introduction

This SDK makes using the Getty Images API easy. It handles credential management, makes HTTP requests and is written with a fluent style in mind. For more info about the API, see the Documentation.

• Search for images and videos from our extensive creative and editorial catalogs.
• Get image and video metadata.
• Download files using your Getty Images products (e.g., Editorial subscriptions, Easy Access, Thinkstock Subscriptions, and Image Packs).
• Custom Request functionality that allows user to call any endpoint.

Help & Support

• Getty Images API
• Contact Developer Support
• Issue Tracker

Minimum Requirements

• You have Java JDK 8 or above installed.
• You have Maven installed

Getting Started

The SDK is available on maven central repository. Include the following dependency in your pom.xml file:

<dependency>
    <groupId>com.gettyimages</groupId>
    <artifactId>gettyimagesapi-sdk</artifactId>
    <version>X.X.X</version>
</dependency>

Install in your workspace with:

$ mvn install

Examples

Search creative images with phrase, age of people, and page

        String apiKey = "API Key";
        String apiSecret = "API Secret";
        String userName = "Username";
        String userPassword = "Password";

        ApiClient client = ApiClient.GetApiClientWithResourceOwnerCredentials(apiKey, apiSecret, userName, userPassword);

      try {
            SearchImagesCreative search = client.searchimagescreative()
                    .withPhrase("cat")
                    .withAgeOfPeople(EnumSet.of(AgeOfPeople.CHILD, AgeOfPeople.BABY,AgeOfPeople.ADULT))
                    .withPage(3);
            String result = search.executeAsync();
            System.out.print(result);

        } catch (SdkException e) {
            System.out.println("Exception occurred while searching for creative images: " + e.getLocalizedMessage());
            System.exit(-1);
        }

Search editorial videos with phrase, fields, format available, and exclude nudity

        String apiKey = "API Key";
        String apiSecret = "API Secret";
        String userName = "Username";
        String userPassword = "Password";

        ApiClient client = ApiClient.GetApiClientWithResourceOwnerCredentials(apiKey, apiSecret, userName, userPassword);

        try {
            SearchVideosEditorial search = client.searchvideoseditorial()
                    .withPhrase("cat")
                    .withResponseFields(Arrays.asList("allowed_use","caption"))
                    .withFormatAvailable(FormatAvailable.HD)
                    .withExcludeNudity(true);
            String result = search.executeAsync();
            System.out.print(result);

        } catch (SdkException e) {
            System.out.println("Exception occurred while searching for creative images: " + e.getLocalizedMessage());
            System.exit(-1);
        }

Custom Request to search images with phrase, fields, and age of people

        String apiKey = "API Key";
        String apiSecret = "API Secret";
        String userName = "Username";
        String userPassword = "Password";

        ApiClient client = ApiClient.GetApiClientWithResourceOwnerCredentials(apiKey, apiSecret, userName, userPassword);

         Map params = new HashMap();
         params.put("phrase", "cat");
         params.put("fields", Arrays.asList("artist", "id"));
         params.put("age_of_people", EnumSet.of(AgeOfPeople.NEWBORN,AgeOfPeople.BABY,AgeOfPeople.CHILD));

         try {
             CustomRequest search = client.customrequest()
                     .withMethod("GET")
                     .withRoute("/search/images")
                     .withQueryParameters(params);
             String result = search.executeAsync();
             System.out.print(result);

         } catch (SdkException e) {
             System.out.println("Exception occurred while searching for creative images: " + e.getLocalizedMessage());
             System.exit(-1);
         }

For more examples, see unittests package.