Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sample API usage #20

Open
ceribik opened this issue Jul 27, 2015 · 2 comments
Open

Sample API usage #20

ceribik opened this issue Jul 27, 2015 · 2 comments
Assignees
Milestone

Comments

@ceribik
Copy link

ceribik commented Jul 27, 2015

Can you provide an example of how to access the API (e.g. using cURL)?

I tried myself but couldn't get the server to respond since it's not a regular API.

@kelsos
Copy link
Collaborator

kelsos commented Jul 27, 2015

You are talking about the REST api from the development tree? I will upload a build with swagger included in the evening along with instructions on how to access the documentation.

@kelsos
Copy link
Collaborator

kelsos commented Jul 27, 2015

OK since I haven't build the development branch for a while I have some issues making it to work. I will check it in the following days as soon as I get some time but here is Swagger.

If you managed to build and run the plugin, just put the swagger zip content in Plugin folder of MusicBee along with the plugin.
You should have something like Plugins\apidoc\index.html now if the plugin is active it should have two Ports available under the settings panel.

If the port is for example 5000 for http, the documentation should be available at http://localhost:5000/apidoc. If you have any problem accessing the port outside of the machine running the plugin, I also have a firewall utility included.

Generally this should provide a clear documentation on what the plugin expects and returns for each call.

If you have an issues feel free to ask me anything.

@kelsos kelsos self-assigned this Jan 19, 2017
@kelsos kelsos added this to the v2.0.0 milestone Jan 19, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants