RaggieSoft Book Version API v1.0.0

Copyright © 2022 RaggieSoft

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the Software), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED AS IS, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

API Usage

The API is used to query the server for the remote versions of my books and Book Reader software, as part of a Check for Updates function.

The Book Reader Version API can be called using a Terminal and executing the php command or it can accept a query from a web browser.

  • php book-data.php --exe_name:[fileName]
  • https://raggiesoft.com/products/books/book-data.php?exe_name=[fileName]

API Returns

The script will return three different responses based on your input. There are two Failure returns and one Success return.

  • 403: file is damaged, or no version information
  • 404: file not found
  • Success: A version string will be returned