Web Service Interface: Difference between revisions

From wiki.jriver.com
Jump to navigation Jump to search
No edit summary
 
(16 intermediate revisions by 3 users not shown)
Line 1: Line 1:
=== Overview ===
J. River Media Center 14 introduced a way for other programs to control the player. It can expose a Web Service Interface. This is self documented by the server with a HTML (or [http://www.w3.org/TR/wsdl WSDL]) response. The documentation just lists the commands available and the syntax for using them.
Other programs can control JRiver by using its [http://en.wikipedia.org/wiki/Representational_State_Transfer REST] based Web Service Interface. This is self documented by the server with an HTML (or [http://www.w3.org/TR/wsdl WSDL]) response. The documentation lists the commands available and the syntax for using them.


The web service is named MCWS (Media Center Web Service).
⚫
You must first start Library Server in MC. If you are running Media Server, this will still be available even after you exit MC. See our Wiki entry on [http://wiki.jrmediacenter.com/index.php/Servers Servers] for more about this.


=== Running the Server ===
⚫
You must first start Library Server in MC. If you are running Media Server, this will still be available even after you exit MC. See our Wiki entry on [http://wiki.jriver.com/index.php/Servers Servers] for more about this.

=== Documentation of Functions ===
Once the server is running, use a web browser to view the documentation. The command is:<br />
Once the server is running, use a web browser to view the documentation. The command is:<br />
http://[library server address]/MCWS/v1/doc
http://[library server address]/MCWS/v1/doc
Line 9: Line 14:
http://[library server address]/MCWS/v1/WSDL
http://[library server address]/MCWS/v1/WSDL


If you're on the same computer as the server, you can use:
If you're on the same computer as the server, you can use:<br />
http://localhost:80/MCWS/v1/doc (where 80 is the port that Library Server is running on)
http://localhost:52199/MCWS/v1/doc (where 52199 is the port that Library Server is running on)

=== Connecting ===
For more information on how to connect to the web service, use Access Keys, and manage authentication, read here:<br />
[[Web Service Connection]]


=== More ===
More on [http://yabb.jriver.com/interact/index.php?topic=53188.msg362433#msg362433 Interact]
More on [http://yabb.jriver.com/interact/index.php?topic=53188.msg362433#msg362433 Interact]


[[Category: Frequently Asked Questions]]
[[Category:Frequently Asked Questions]]
[[Category:Developer]]
[[Category:Media Network]]

Latest revision as of 19:13, 27 February 2018

Overview

Other programs can control JRiver by using its REST based Web Service Interface. This is self documented by the server with an HTML (or WSDL) response. The documentation lists the commands available and the syntax for using them.

The web service is named MCWS (Media Center Web Service).

Running the Server

You must first start Library Server in MC. If you are running Media Server, this will still be available even after you exit MC. See our Wiki entry on Servers for more about this.

Documentation of Functions

Once the server is running, use a web browser to view the documentation. The command is:
http://[library server address]/MCWS/v1/doc

To view the documentation in WSDL format, use:
http://[library server address]/MCWS/v1/WSDL

If you're on the same computer as the server, you can use:
http://localhost:52199/MCWS/v1/doc (where 52199 is the port that Library Server is running on)

Connecting

For more information on how to connect to the web service, use Access Keys, and manage authentication, read here:
Web Service Connection

More

More on Interact

Retrieved from "https://wiki.jriver.com/index.php?title=Web_Service_Interface&oldid=15456"