Rise Vision API exposes our Rise Vision core functionalities through a RESTful web service built using Google Cloud Endpoints from Google App Engine.
This project was created to help those who may use the API to understand it through its documentation and an interactive console as a live sample code.
The documentation is kept on the Wiki while the interactive console is running on a github page.
Our main purpose is that while you are reading up the documentation you can also try it out. Moreover you are free to use the interactive console source code in your apps. Feel free to copy it!!!
If you know what you are doing you can perfectly use the interactive console to manage your Rise Vision account as well.
Furthermore, you can help us to improve it. You are more then welcome to become a contributor or either suggest improvements. Please Fork and send us a pull request. If we consider your changes relevant to the time being, we will definitely merge it.
Rise Vision API works in conjunction with Rise Vision, the digital signage management application that runs on Google Cloud.
At this time Chrome is the only browser that this project and Rise Vision supports.
- Google APIs Client Library for JavaScript
- RiseVision Common Style
- HTML 5
- JavaScript
To make calls to Google Cloud Endpoits the Google Javascript Client API needs to be setup with a valid client id which comes from an app created on Google App Engine.
The client id is configured with a javascript origin attribute.This tights up a client id with the domain url of the server in which the Google JavaScript Client API runs.
For instance, if I run the interactive console on my local apache server. I will have to use a client id which the attribute javascript_origin is set to http://localhost:8080.
- clone the repo using Git to your local:
git clone https://github.com/Rise-Vision/core-api.git- Go to "Run Client" section in readme to see how to run this app.
- in git bash run this cmd at where you want the repo to be cloned to locally:
git clone https://github.com/Rise-Vision/storage-client.git- Go to "Run Client" section in readme to see how to run this app.
To run the application you will need to deploy it to a web server such as the Apache Http Server. It must be configured to serve the application on http://localhost:8080. We will not explain here how to setup such server. We consider you already know how to do that.
-
deploy the application to the web server
-
application should be running on http://localhost:8080
If you encounter problems or find defects we really want to hear about them. If you could take the time to add them as issues to this Repository it would be most appreciated. When reporting issues please use the following format where applciable:
Reproduction Steps
- did this
- then that
- followed by this (screenshots / video captures always help)
Expected Results
What you expected to happen.
Actual Results
What actually happened. (screenshots / video captures always help)
All contributions are greatly appreciated and welcome! If you would first like to sound out your contribution ideas please post your thoughts to our community, otherwise submit a pull request and we will do our best to incorporate it
- Show the javascript code snippet which makes the api call besides the form.
- Create a json editor so it can be used instead of filling out the form.
If you have any questions or problems please don't hesitate to join our lively and responsive community at http://community.risevision.com.
If you are looking for user documentation on Rise Vision please see http://www.risevision.com/help/users/
If you would like more information on developing applications for Rise Vision please visit http://www.risevision.com/help/developers/.
Facilitator