PlexSDK Java SDK 0.0.1

A Java SDK for PlexSDK.

An Open API Spec for interacting with Plex.tv and Plex Servers

• API version: 0.0.1
• SDK version: 0.0.1

Table of Contents

• Requirements
• Installation
  • Dependencies
• Authentication
  • API Key
• API Endpoint Services
• API Models
• Testing
• Configuration
• Sample Usage
• License

Requirements

• Java 8
• Maven

Installation

If you use Maven, place the following within the tag in your pom.xml file:

<dependency>
  <groupId>47.one0</groupId>
  <artifactId>plex-sdk</artifactId>
  <version>0.0.1</version>
</dependency>

If you use Gradle, paste the next line inside the dependencies block of your build.gradle file:

implementation group: "47.one0", name: "PlexSDK", version: "0.0.1"

Authentication

To see whether an endpoint needs a specific type of authentication check the endpoint's documentation.

API Key

The PlexSDK API uses API keys as a form of authentication. An API key is a unique identifier used to authenticate a user, developer, or calling program to an API.

The API key can be set for the SDK through:

PlexSDK sdk = new PlexSDK("YOUR_API_KEY", "YOUR_API_KEY_HEADER");

API Endpoint Services

All URIs are relative to http://10.10.10.47:32400.

Click the service name for a full list of the service methods.

Service
ServerService
MediaService
ActivitiesService
ButlerService
HubsService
SearchService
LibraryService
LogService
PlaylistsService
SecurityService
SessionsService
UpdaterService
VideoService

API Models

A list documenting all API models for this SDK.

Testing

Unit tests aren't available yet. When they are, you'll be able to run them with this command:

mvn clean test

Configuration

Your SDK may require some configuration changes.

This API is configured to use a security token for authorization. You should edit examples/src/main/java/47/one0/examples/Main.java and paste your own tokens in place of PLEXSDK_API_KEY & PLEXSDK_API_KEY_HEADER.

Sample Usage

package 47.one0.examples;

import 47.one0.exceptions.ApiException;
import 47.one0.PlexSDK;

public class Main {

  public static void main(String[] args) {
    PlexSDK client = new PlexSDK(System.getenv("PLEXSDK_API_KEY"), System.getenv("PLEXSDK_API_KEY_HEADER"));
    try {
        Object response = client.serverService.getServerCapabilities();
        System.out.println(response);
    } catch(ApiException e) {
        e.printStackTrace();
    }
  }
}

Inside this directory is examples/src/main/java/47/one0/examples/Main.java. It's a simple, "hello, world" level program to demonstate this SDK. Run install.sh to prepare the SDK for use.

To see what other functions this SDK is capable of, look inside src/main/java/47/one0/http/*Client.java.

License

License: MIT. See license in LICENSE.