入门

要访问Plex api，请完成以下步骤:

要求Plex的API开发者账户

一个plex开发者帐号才能访问开发者门户网站，并调用API。

  1. 要申请开发人员帐户，你的Plex冠军必须提交一个案例到Plex支持云服务。包括你需要创建的每个帐户名和电子邮件地址。
  2. 丛将审核您的请求，并发送确认邮件到电子邮件帐户您请求。
  3. 您将通过电子邮件通知时，您的帐户已创建。按照电子邮件中的说明登录到开发者门户网站。
  4. 成功访问开发者门户网站，您必须在门户中创建一个应用程序来获取您的API密钥。

获得API凭证

要获取您的API凭证（使用者密钥和秘密），创建于Plex的开发者门户网站的应用程序。

  1. 访问Plex的开发者门户网站在developers.plex.com。
  2. 点击您的帐户名和选择我的应用程序。
  3. 请点击+添加一个新的应用程序。
  4. 在添加应用程序屏幕，为你的应用输入一个名字。
  5. 对于产品，选择您要访问的API产品。
  6. 请点击创建应用程序

消费者密钥和消费者秘密为您的应用程序生成并显示在屏幕上

调用API

如果你有一个Plex的API开发者账户，您可以在Plex的开发者门户网站中直接测试Plex的的API。

  1. 在里面开发者门户网站，去API页面上。
  2. 单击要测试的API操作。
  3. 单击资源，以查看其详细信息，包括资源的URL和请求主体。
  4. 请求体后，在API密钥现场，点击组。
    1. 对于名称,类型X-PLEX-连接-API密钥。
    2. 要有价值，键入您的客户密钥。(你可以从你创建的应用程序中检索。参见获取API凭证。)
    3. 选择头。
    4. 请点击好吧。
  5. 请点击发送该请求。
  6. API请求被发送。该页面将与响应更新。
  7. 一个成功的响应后，您就可以使用API​​。更新的ServiceCloud你的情况，以确认您能够访问API。

错误代码

400 - 错误的要求
400错误通常表明所要求的要求的资源不匹配的身体。

400 -验证失败
一个或多个参数使用了不正确的格式，或者在请求中省略了这些参数。

401 - 请求未通过认证
当您尝试访问使用过期的API密钥，无效的API密钥系统，或没有在所有的API密钥，可能会发生401错误。
如果您收到此错误，验证X-PLEX-连接-API-Key标头是在请求和密钥在Plex的开发者门户网站的价值相匹配指定。

404 - 未找到资源
当应用程序试图使用不正确的请求URL访问Plex功能，或者没有数据可以返回时，可能会发生404错误。

请求处理错误
500错误是意外。如果你能重现错误，提交支持票Plex的。包括的步骤重复问题，但不包括客户端机密，密码，或订阅键。

进行API调用

请求头

订阅密钥头

所有Plex的API请求都需要一个有效的订阅密钥头。请求头X-PLEX-连接-API密钥是它提供了访问API订阅密钥。您可以获得通过Plex的开发者门户网站的API密钥。
如果不包括在API请求认购键头，或提供一个无效的订阅密钥，您会收到以下消息：

{“码”：“REQUEST_NOT_AUTHENTICATED”，
 “信息” ： “该请求无法被验证。”
}

租户ID报头

Plex API请求在单个默认租户(也称为实体或PCN)的上下文中执行。请求头X-PLEX-连接租户-ID可用于执行用于比默认一个其他租户的请求。标头值在使用必须是一个租户ID。

顾客ID头

Plex API请求在单个默认租户(也称为实体或PCN)的上下文中执行。请求头X-Plex的 - 连接 - 客户-ID可用于执行用于比默认一个其它不同承租人的请求。标头值在使用必须是一个PCN的值。
如果您没有访问请求的租户，您将收到以下消息：

{“码”：“REQUEST_NOT_AUTHENTICATED”，
 “信息” ： “该请求无法被验证。”
}

URL结构

托管端点有如下形式：

HTTPS：[梯队] // connect.plex.com/ {收集} / {版本} / {}资源[/ {资源ID}] [过滤器]

例：https://connect.plex.com/mdm/v1/employees?lastName=smith

列表查询字符串参数

了一些API，可以接受查询字符串参数列表的方法。
要为列表查询字符串参数使用多个值，构造查询字符串参数及其值对的多个实例的URL。
例如，对于查询字符串参数ID如果可以接受一个值列表，则请求的URL可能类似于下面的示例:

https://?Id=value1&Id=value2&Id=value3。

在这个例子中，提供了用于在Idquery字符串参数三个不同的值，并且请求将使用列出的三个参数。

日期和时间

协调世界时（UTC）

使用UTC或UTC+偏移量标准数据和时间格式。

格式字符串

使用任何日期或时间输入参数的格式如下：

YYYY-MM-DDTHH：MM：ss.fffffffZ

符号

YYYY四位数年份（必填）
MM两位数的月份（01至12，必需）
本月DD两位数天（通过28/29/30/31 01，必需）
日期和时间分量T之间的常数炭分离器（必需）
HH两位数小时（00至23，必需）
毫米两位数分钟（00至59，必需）
SS两位数第二（00至59，可选）
FFFFFFF小数位的第二（0至7位数字，可选）
Z常数字符指定为UTC又名“祖鲁时间”（必需）

以下也适用：

  • 该秒组件可以被排除在外。
  • 秒的小数位数可以被排除，但当包含时，不能超过7位。这适用于botj输入和输出。
  • 尾随零是允许的，但不是必需的

以下是不支持：

  • 日期没有时间
  • 没有时区的时间
  • 小数位数的任何东西，除了秒
  • 使用空格代替“T”字符作为日期时间分隔符

精度范围

1999-12-31T12：34Z
1999 - 12 - 31 - t12:34:56z
1999-12-31T12：34：56.1Z
1999 - 12 - 31 - t12:34:56.12z
1999-12-31T12：34：56.123Z
1999-12-31T12：34：56.1234Z
1999 - 12 - 31 - t12:34:56.12345z
1999 - 12 - 31 - t12:34:56.123456z
1999-12-31T12：34：56.1234567Z

查看PDF格式。