starred/newznab-tmux
1
0
Fork 0
mirror of https://github.com/NNTmux/newznab-tmux.git synced 2026-08-29 01:08:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

Use api/v1 for api

Browse Source
This commit is contained in:
DariusIII
2018-04-18 12:50:11 +02:00
parent b2de0d7fc9
commit bb4fa02745
3 changed files with 17 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Changelog
+1
View File
@@ -1,4 +1,5 @@
2018-04-18 DariusIII
* Chg: Use api/v1 for api
* Chg: Add CollectionRegexesController
* Chg: Update routes
* Chg: Add CategoryRegexesController
resources/views/themes/shared/apidesc.tpl
+10 -10
View File
@@ -4,22 +4,22 @@
<br>
{if $loggedin=="true"}
<h3>API Credentials</h3>
<p>Your credentials should be provided as <span style="font-family:courier;">?apikey={$userdata.rsstoken}</span></p>
<p>Your credentials should be provided as <span style="font-family:courier;">&apikey={$userdata.rsstoken}</span></p>
{/if}
<br>
<h3>Available Functions</h3>
<p>Use the parameter <span style="font-family:courier;">?t=</span> to specify the function being called.</p>
<dl>
<dt>Capabilities <span style="font-family:courier;"><a href="{$smarty.const.WWW_TOP}/api?t=caps">?t=caps</a></span></dt>
<dt>Capabilities <span style="font-family:courier;"><a href="{$smarty.const.WWW_TOP}/api/v1/api?t=caps">?t=caps</a></span></dt>
<dd>Reports the capabilities if the server. Includes information about the server name, available search categories and version number of the newznab protocol being used.<br>Capabilities does not require any credentials in order to be ran.</dd>
<br>
<dt>Search <span style="font-family:courier;"><a href="{$smarty.const.WWW_TOP}/api?t=search&amp;q=linux">?t=search&amp;q=linux</a></span></dt>
<dt>Search <span style="font-family:courier;"><a href="{$smarty.const.WWW_TOP}/api/v1/api?t=search&amp;q=linux">?t=search&amp;q=linux</a></span></dt>
<dd>Returns a list of nzbs matching a query. You can also filter by site category by including a comma separated list of categories as follows <span style="font-family:courier;"><a href="{$smarty.const.WWW_TOP}/api?t=search&amp;cat={$catClass::GAME_ROOT},{$catClass::MOVIE_ROOT}">?t=search&amp;cat={$catClass::GAME_ROOT},{$catClass::MOVIE_ROOT}</a></span>. Include <span style="font-family:courier;">&amp;extended=1</span> to return extended information in the search results.</dd>
<br>
<dt>TV <span style="font-family:courier;"><a href="{$smarty.const.WWW_TOP}/api?t=tvsearch&amp;q=law%20and%20order&amp;season=7&amp;ep=12">?t=tvsearch&amp;q=law and order&amp;season=7&amp;ep=12</a></span></dt>
<dt>TV <span style="font-family:courier;"><a href="{$smarty.const.WWW_TOP}/api/v1/api?t=tvsearch&amp;q=law%20and%20order&amp;season=7&amp;ep=12">?t=tvsearch&amp;q=law and order&amp;season=7&amp;ep=12</a></span></dt>
<dd>Returns a list of nzbs matching a query, category, tvrageid, season or episode.
You can also filter by site category by including a comma separated list of categories as follows:
<span style="font-family:courier;"><a href="{$smarty.const.WWW_TOP}/api?t=tvsearch&amp;rid=2204&amp;cat={$catClass::GAME_ROOT},{$catClass::MOVIE_ROOT}">?t=tvsearch&amp;cat={$catClass::GAME_ROOT},{$catClass::MOVIE_ROOT}</a></span>.
<span style="font-family:courier;"><a href="{$smarty.const.WWW_TOP}/api/v1/api?t=tvsearch&amp;rid=2204&amp;cat={$catClass::GAME_ROOT},{$catClass::MOVIE_ROOT}">?t=tvsearch&amp;cat={$catClass::GAME_ROOT},{$catClass::MOVIE_ROOT}</a></span>.
Include <span style="font-family:courier;">&amp;extended=1</span> to return extended information in the search results.
</dd>
<dd>
@@ -27,18 +27,18 @@
&amp;rid=25056 (TVRage) &amp;tvdbid=153021 (TVDB) &amp;traktid=1393 (Trakt) &amp;tvmazeid=73 (TVMaze) &amp;imdbid=1520211 (IMDB) &amp;tmdbid=1402 (TMDB).
</dd>
<br>
<dt>Movies <span style="font-family:courier;"><a href="{$smarty.const.WWW_TOP}/api?t=movie&amp;imdbid=1418646">?t=movie&amp;imdbid=1418646</a></span></dt>
<dt>Movies <span style="font-family:courier;"><a href="{$smarty.const.WWW_TOP}/api/v1/api?t=movie&amp;imdbid=1418646">?t=movie&amp;imdbid=1418646</a></span></dt>
<dd>Returns a list of nzbs matching a query, an imdbid and optionally a category. Filter by
site category by including a comma separated list of categories as follows <span
style="font-family:courier;"><a href="{$smarty.const.WWW_TOP}/api?t=movie&amp;imdbid=1418646&amp;cat={$catClass::MOVIE_SD},{$catClass::MOVIE_HD}">?t=movie&amp;imdbid=1418646&amp;cat={$catClass::MOVIE_SD},{$catClass::MOVIE_HD}</a></span>. Include <span style="font-family:courier;">&amp;extended=1</span> to return extended information in the search results.</dd>
style="font-family:courier;"><a href="{$smarty.const.WWW_TOP}/api/v1/api?t=movie&amp;imdbid=1418646&amp;cat={$catClass::MOVIE_SD},{$catClass::MOVIE_HD}">?t=movie&amp;imdbid=1418646&amp;cat={$catClass::MOVIE_SD},{$catClass::MOVIE_HD}</a></span>. Include <span style="font-family:courier;">&amp;extended=1</span> to return extended information in the search results.</dd>
<br>
<dt>Details <span style="font-family:courier;"><a href="{$smarty.const.WWW_TOP}/api?t=details&amp;id=9ca52909ba9b9e5e6758d815fef4ecda">?t=details&amp;id=9ca52909ba9b9e5e6758d815fef4ecda</a></span></dt>
<dt>Details <span style="font-family:courier;"><a href="{$smarty.const.WWW_TOP}/api/v1/api?t=details&amp;id=9ca52909ba9b9e5e6758d815fef4ecda">?t=details&amp;id=9ca52909ba9b9e5e6758d815fef4ecda</a></span></dt>
<dd>Returns detailed information about an nzb.</dd>
<br>
<dt>Info <span style="font-family:courier;"><a href="{$smarty.const.WWW_TOP}/api?t=info&amp;id=9ca52909ba9b9e5e6758d815fef4ecda">?t=info&amp;id=9ca52909ba9b9e5e6758d815fef4ecda</a></span></dt>
<dt>Info <span style="font-family:courier;"><a href="{$smarty.const.WWW_TOP}/api/v1/api?t=info&amp;id=9ca52909ba9b9e5e6758d815fef4ecda">?t=info&amp;id=9ca52909ba9b9e5e6758d815fef4ecda</a></span></dt>
<dd>Returns NFO contents for an NZB. Retrieve the NFO as file by specifying o=file in the request URI.</dd>
<br>
<dt>Get <span style="font-family:courier;"><a href="{$smarty.const.WWW_TOP}/api?t=get&amp;id=9ca52909ba9b9e5e6758d815fef4ecda">?t=get&amp;id=9ca52909ba9b9e5e6758d815fef4ecda</a></span></dt>
<dt>Get <span style="font-family:courier;"><a href="{$smarty.const.WWW_TOP}/api/v1/api?t=get&amp;id=9ca52909ba9b9e5e6758d815fef4ecda">?t=get&amp;id=9ca52909ba9b9e5e6758d815fef4ecda</a></span></dt>
<dd>Downloads the nzb file associated with an Id.</dd>
</dl>
<br>
routes/web.php
+6 -2
View File
@@ -49,8 +49,12 @@ Route::prefix('cart')->group(function () {
Route::post('delete/{id}', 'CartController@destroy');
});
Route::get('api', 'Api\ApiController@api')->middleware('api');
Route::post('api', 'Api\ApiController@api')->middleware('api');
Route::prefix('api/v1')->group(function () {
Route::namespace('Api')->group(function () {
Route::get('api', 'ApiController@api');
Route::post('api', 'ApiController@api');
});
});
Route::get('details/{guid}', 'DetailsController@show');
Route::post('details/{guid}', 'DetailsController@show');