PMS web api documentation

Dev Community Dev/API Corner
61

thanks, but that's not the same list. it's a short list with only the servers.

https://plex.tv/servers.xml had also the library sections of each server included.

i fixed my scripts to use the short list and query the server for the library sections.

62

I'm developing a small plex client and I want to support casting / remote controlling from other plex clients. I understand all the api payback calls that the client needs to handle for remote from the google code wiki. What I don't quite understand is how to register the client with plex so that it will appear as player remote / casting option to other plex clients. Is there an api call for this or some kind of signal the client needs to be sending? Thanks.

63

I'm developing a small plex client and I want to support casting / remote controlling from other plex clients. I understand all the api payback calls that the client needs to handle for remote from the google code wiki. What I don't quite understand is how to register the client with plex so that it will appear as player remote / casting option to other plex clients. Is there an api call for this or some kind of signal the client needs to be sending? Thanks.


This could be a question of listening for signals then sending them. Although I do vaguely remember a call that can be made to a server to lost local clients. It could be that you need to send a "supported" user agent with all your calls.

Hopefully that will send you in the right direction. Sorry I don't have more info.


Sent from my iPhone using Tapatalk
64

I have been contributing to the documentation, can someone add me as a Committer?

65

I have a general question about the plex api, i think this is the best thread for this question.

I try to access my Library over the internet. So me and my friends have access over the internet. I can sign in with my credentials and got an authtoken. (https://plex.tv/users/sign_in.xml)

Is it possible to access with the api description from https://code.google.com/p/plex-api/wiki/PlexWebAPIOverviewto my server?

I try it with this link: http://someadress.dyndns.org:32400/serversbut always got an 401 Unauthorized error.

So i hope anyone can help me with this problem.

Thank you

Cheers raphi

66

I have a general question about the plex api, i think this is the best thread for this question.

I try to access my Library over the internet. So me and my friends have access over the internet. I can sign in with my credentials and got an authtoken. (https://plex.tv/users/sign_in.xml)

Is it possible to access with the api description from https://code.google.com/p/plex-api/wiki/PlexWebAPIOverviewto my server?

I try it with this link: http://someadress.dyndns.org:32400/serversbut always got an 401 Unauthorized error.

So i hope anyone can help me with this problem.

Thank you
Cheers raphi

I havent touched this stuff in a good while but I do vaguely remember this endpoint being "private" and only a available if accessed via localhost.

However, if you are able to access it you must pass the following headers:
X-Plex-Token=
X-Plex-Username=.

Hope that helps


Sent from my iPhone using Tapatalk
67

I have been contributing to the documentation, can someone add me as a Committer?


Have you been added to this?


Sent from my iPhone using Tapatalk
68

Not sure if everyone heard the news but google code will be shutting down so this weekend i’ll be migrating this documentation to github. Will update further soon.



Sent from my iPhone using Tapatalk

69

I'm not sure if this is the right place, but I'm curious. Does anyone know if we are able to have an app of ours utilize the plex pin feature to authenticate users without giving out the password to an account?

70

So have been trying to fix htpc-managers send to plex. The idea send that command to any active players supporting it.

I have tried:

http://:/player/playback/playMedia?key=%2Flibrary%2Fmetadata%2F&offset=0&X-Plex-Client-Identifier=&machineIdentifier=&address=&port=&protocol=http&path=http%3A%2F%2F%3A%2Flibrary%2Fmetadata%2F

 
 
This issue has been resolved.
71

I'm not sure if this is the right place, but I'm curious. Does anyone know if we are able to have an app of ours utilize the plex pin feature to authenticate users without giving out the password to an account?


Yes you can

POST to https://plex.tv/pinsto get a pin code and id, then check with a GET to https://plex.tv/pins/.xml

You probably need to send the headers X-Plex-Product, X-Plex-Version, X-Plex-Client-Identifier, X-Plex-Device, X-Plex-Device-Name along with the Accept application/xml header

That's the simplified and far from complete method.

I am however having an issue that the device card on the /web/index.html#!/settings/devices page is showing blank, might need more headers or something.
72

Since I didn't want this to get lost to the ages, and @reallistic hadn't posted about it in 2 months:

I've migrated the documentation over to GitHub here: https://github.com/Arcanemagus/plex-api/wiki

Please update this with anything you have discovered in your development exploration so that we may all benefit ;)

73

Since I didn't want this to get lost to the ages, and @reallistic hadn't posted about it in 2 months:

I've migrated the documentation over to GitHub here: https://github.com/Arcanemagus/plex-api/wiki

Please update this with anything you have discovered in your development exploration so that we may all benefit ;)

Thanks for this! I did actually migrate it to github via google code's tool but it gave me some very interestingly formatted files and I never had the chance to convert them into github wiki's.

74

Thanks for this! I did actually migrate it to github via google code's tool but it gave me some very interestingly formatted files and I never had the chance to convert them into github wiki's.

Yea, the Wiki format is different on Google Code vs the Markdown used by Github. I'm not sure why Google didn't automate conversion and put them in the Github Wiki, but in any case I manually converted the pages over to Github Markdown.

75

@reallistic said:
raphibolliger wrote on March 10 2015, 1:57 PM: »

I have a general question about the plex api, i think this is the best thread for this question.

I try to access my Library over the internet. So me and my friends have access over the internet. I can sign in with my credentials and got an authtoken. (https://plex.tv/users/sign_in.xml)

Is it possible to access with the api description from Google Code Archive - Long-term storage for Google Code Project Hosting. my server?

I try it with this link: http://someadress.dyndns.org:32400/serversbut always got an 401 Unauthorized error.

So i hope anyone can help me with this problem.

Thank you
Cheers raphi

I havent touched this stuff in a good while but I do vaguely remember this endpoint being “private” and only a available if accessed via localhost.

However, if you are able to access it you must pass the following headers:
X-Plex-Token=
X-Plex-Username=.

Hope that helps

Sent from my iPhone using Tapatalk

did this work for anyone??? as I have the same issue… in this thread

76

@mr3rown said:
did this work for anyone??? as I have the same issue… in this thread

Responded over in your thread, but it should be working :wink:

77

@Arcanemagus said:

Still no joy… what I am trying to do is

http://PublicWANIPAddress:32400/library/sections/1/recentlyAdded?X-Plex-Token=xxxxxxxxxxxxxx&X-Plex-Username=xxxxxxx

Works Locally, but I need it to work from a remote computer not on my local network, as my app will be a hosted app using a python script to parse the XML results to then send on to another app to do something else.

78

@mr3rown said:
Works Locally, but I need it to work from a remote computer not on my local network, as my app will be a hosted app using a python script to parse the XML results to then send on to another app to do something else.

This thread is about documenting the API, let’s keep discussion of your issue over in your dedicated thread.

79

Anyone know if there is an endpoint that can be used to retrieve the latest PMS version numbers? If not, is there any chance this could be added?

80

Is there a way to determine the “secure” status of a server prior to connecting to it? I was hoping that this info would have been added to the PMS/servers endpoint, but it’s not. I want to add support for connecting to a secure server, but want to make sure there’s not a better way than brute force attempting HTTPS first, then falling back to HTTP. Thanks.