mirror of
https://github.com/LukeHagar/plexpy.git
synced 2025-12-06 04:20:52 +00:00
91 lines
8.3 KiB
Markdown
91 lines
8.3 KiB
Markdown
# Plex
|
|
(*plex*)
|
|
|
|
## Overview
|
|
|
|
API Calls that perform operations directly against https://Plex.tv
|
|
|
|
|
|
### Available Operations
|
|
|
|
* [get_pin](#get_pin) - Get a Pin
|
|
* [get_token](#get_token) - Get Access Token
|
|
|
|
## get_pin
|
|
|
|
Retrieve a Pin from Plex.tv for authentication flows
|
|
|
|
### Example Usage
|
|
|
|
```python
|
|
import plex_api
|
|
|
|
s = plex_api.PlexAPI()
|
|
|
|
|
|
res = s.plex.get_pin(x_plex_client_identifier='<value>', strong=False)
|
|
|
|
if res.object is not None:
|
|
# handle response
|
|
pass
|
|
|
|
```
|
|
|
|
### Parameters
|
|
|
|
| Parameter | Type | Required | Description |
|
|
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| `x_plex_client_identifier` | *str* | :heavy_check_mark: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> |
|
|
| `strong` | *Optional[bool]* | :heavy_minus_sign: | Determines the kind of code returned by the API call<br/>Strong codes are used for Pin authentication flows<br/>Non-Strong codes are used for `Plex.tv/link`<br/> |
|
|
| `server_url` | *Optional[str]* | :heavy_minus_sign: | An optional server URL to use. |
|
|
|
|
|
|
### Response
|
|
|
|
**[operations.GetPinResponse](../../models/operations/getpinresponse.md)**
|
|
### Errors
|
|
|
|
| Error Object | Status Code | Content Type |
|
|
| ------------------------- | ------------------------- | ------------------------- |
|
|
| errors.GetPinResponseBody | 400 | application/json |
|
|
| errors.SDKError | 4x-5xx | */* |
|
|
|
|
## get_token
|
|
|
|
Retrieve an Access Token from Plex.tv after the Pin has already been authenticated
|
|
|
|
### Example Usage
|
|
|
|
```python
|
|
import plex_api
|
|
|
|
s = plex_api.PlexAPI()
|
|
|
|
|
|
res = s.plex.get_token(pin_id='<value>', x_plex_client_identifier='<value>')
|
|
|
|
if res is not None:
|
|
# handle response
|
|
pass
|
|
|
|
```
|
|
|
|
### Parameters
|
|
|
|
| Parameter | Type | Required | Description |
|
|
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| `pin_id` | *str* | :heavy_check_mark: | The PinID to retrieve an access token for |
|
|
| `x_plex_client_identifier` | *str* | :heavy_check_mark: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> |
|
|
| `server_url` | *Optional[str]* | :heavy_minus_sign: | An optional server URL to use. |
|
|
|
|
|
|
### Response
|
|
|
|
**[operations.GetTokenResponse](../../models/operations/gettokenresponse.md)**
|
|
### Errors
|
|
|
|
| Error Object | Status Code | Content Type |
|
|
| --------------------------- | --------------------------- | --------------------------- |
|
|
| errors.GetTokenResponseBody | 400 | application/json |
|
|
| errors.SDKError | 4x-5xx | */* |
|