mirror of
https://github.com/idanoo/GoScrobble
synced 2025-07-01 21:52:19 +00:00
Update API docs
This commit is contained in:
parent
306bab997b
commit
c860b4e2b7
9 changed files with 714 additions and 39 deletions
|
|
@ -315,11 +315,25 @@
|
|||
<li>
|
||||
<a href="#introduction" class="toc-h1 toc-link" data-title="Introduction">Introduction</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#rate-limits" class="toc-h1 toc-link" data-title="Rate Limits">Rate Limits</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#server-info" class="toc-h1 toc-link" data-title="Server Info">Server Info</a>
|
||||
<ul class="toc-list-h2">
|
||||
<li>
|
||||
<a href="#v1-serverinfo" class="toc-h2 toc-link" data-title="v1/serverinfo">v1/serverinfo</a>
|
||||
<a href="#get-v1-serverinfo" class="toc-h2 toc-link" data-title="GET v1/serverinfo">GET v1/serverinfo</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#ingress-endpoints" class="toc-h1 toc-link" data-title="Ingress Endpoints">Ingress Endpoints</a>
|
||||
<ul class="toc-list-h2">
|
||||
<li>
|
||||
<a href="#post-v1-ingress-jellyfin" class="toc-h2 toc-link" data-title="POST v1/ingress/jellyfin">POST v1/ingress/jellyfin</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#post-v1-ingress-multiscrobbler" class="toc-h2 toc-link" data-title="POST v1/ingress/multiscrobbler">POST v1/ingress/multiscrobbler</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
|
@ -327,16 +341,30 @@
|
|||
<a href="#authentication" class="toc-h1 toc-link" data-title="Authentication">Authentication</a>
|
||||
<ul class="toc-list-h2">
|
||||
<li>
|
||||
<a href="#v1-login" class="toc-h2 toc-link" data-title="v1/login">v1/login</a>
|
||||
<a href="#post-v1-login" class="toc-h2 toc-link" data-title="POST v1/login">POST v1/login</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#v1-register" class="toc-h2 toc-link" data-title="v1/register">v1/register</a>
|
||||
<a href="#post-v1-register" class="toc-h2 toc-link" data-title="POST v1/register">POST v1/register</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#v1-sendreset" class="toc-h2 toc-link" data-title="v1/sendreset">v1/sendreset</a>
|
||||
<a href="#post-v1-sendreset" class="toc-h2 toc-link" data-title="POST v1/sendreset">POST v1/sendreset</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#v1-resetpassword" class="toc-h2 toc-link" data-title="v1/resetpassword">v1/resetpassword</a>
|
||||
<a href="#post-v1-resetpassword" class="toc-h2 toc-link" data-title="POST v1/resetpassword">POST v1/resetpassword</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#post-v1-refresh" class="toc-h2 toc-link" data-title="POST v1/refresh">POST v1/refresh</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#admin-endpoints" class="toc-h1 toc-link" data-title="Admin Endpoints">Admin Endpoints</a>
|
||||
<ul class="toc-list-h2">
|
||||
<li>
|
||||
<a href="#get-v1-config" class="toc-h2 toc-link" data-title="GET v1/config">GET v1/config</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#post-v1-config" class="toc-h2 toc-link" data-title="POST v1/config">POST v1/config</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
|
@ -353,8 +381,20 @@
|
|||
<h1 id='introduction'>Introduction</h1>
|
||||
<p>Welcome to the GoScrobble API documentation.</p>
|
||||
|
||||
<p>The majority of these API endpoints are public with reasonable rate limits.</p>
|
||||
<h1 id='server-info'>Server Info</h1><h2 id='v1-serverinfo'>v1/serverinfo</h2>
|
||||
<p>The majority of these API endpoints are public with rate limiting and do not require authentication.</p>
|
||||
<h1 id='rate-limits'>Rate Limits</h1>
|
||||
<p>There are 3 tiers of rate-limiting:<br>
|
||||
Light rate-limiting: 1 request per 4 seconds with a max burst of 2.<br>
|
||||
Standard rate-limiting: 5 requests per second with a burst of 5.<br>
|
||||
Heavy rate-limiting: 10 requests per second with a burst of 10. </p>
|
||||
|
||||
<p>The rate limits work as a 'bucket' system where there is a max (burst) and a regenerative rate. More info can be found in the source file server_middleware.go.</p>
|
||||
|
||||
<p>Each endpoint will depict which rate limit applies.</p>
|
||||
|
||||
<p>For example:
|
||||
On the medium rate-limiter, you start with 5 requests available to you instantly, and this replenishes 5 requests per second.</p>
|
||||
<h1 id='server-info'>Server Info</h1><h2 id='get-v1-serverinfo'>GET v1/serverinfo</h2>
|
||||
<blockquote>
|
||||
<p>Check server version and registration status:</p>
|
||||
</blockquote>
|
||||
|
|
@ -371,12 +411,299 @@
|
|||
<p>This endpoint is used to get server API version and registration status.</p>
|
||||
<h3 id='http-request'>HTTP Request</h3>
|
||||
<p><code>GET https://goscrobble.com/api/v1/serverstatus</code></p>
|
||||
<h1 id='authentication'>Authentication</h1><h2 id='v1-login'>v1/login</h2>
|
||||
<h1 id='ingress-endpoints'>Ingress Endpoints</h1>
|
||||
<p>Spotify and Navidrome both work on a poll based system and do not require incoming webhooks/endpoints.</p>
|
||||
<h2 id='post-v1-ingress-jellyfin'>POST v1/ingress/jellyfin</h2>
|
||||
<blockquote>
|
||||
<p>Submit a scrobble:</p>
|
||||
</blockquote>
|
||||
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="s2">"https://goscrobble.com/api/v1/ingress/jellyfin"</span> <span class="se">\</span>
|
||||
<span class="nt">-H</span> <span class="s2">"Content-Type: application/json"</span> <span class="se">\</span>
|
||||
<span class="nt">-H</span> <span class="s2">"Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhZG1pbiI6ZmFsc2UsImVtYWlsIjoidGVzdEB0ZXN0LmNvbSIsImV4cCI6MTY0MTAwMjUxOSwiaWF0IjoxNjQwMzk3NzE5LCJtb2QiOnRydWUsI"</span> <span class="se">\</span>
|
||||
<span class="nt">-X</span> POST <span class="se">\</span>
|
||||
<span class="nt">--data</span> <span class="s1">'{"Name":"<Full JSON structure located in ingress_jellyfin.go>", "Album":"Best Album","Artist":"Best Artist"}'</span>
|
||||
</code></pre></div>
|
||||
<blockquote>
|
||||
<p>Response:</p>
|
||||
</blockquote>
|
||||
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
||||
</span><span class="nl">"message"</span><span class="p">:</span><span class="w"> </span><span class="s2">"success"</span><span class="w">
|
||||
</span><span class="p">}</span><span class="w">
|
||||
</span></code></pre></div>
|
||||
<p>Adds a scrobble from Jellyfin into the database. Please view <code>type JellyfinRequest struct</code> in ingress_jellyfin.go for the full request format. You need to install the webhook plugin for this to work.</p>
|
||||
|
||||
<aside class="notice">
|
||||
Light rate-limiting applies
|
||||
</aside>
|
||||
<h3 id='http-request'>HTTP Request</h3>
|
||||
<p><code>POST https://goscrobble.com/api/v1/ingress/jellyfin</code></p>
|
||||
<h3 id='query-parameters'>Query Parameters</h3>
|
||||
<table><thead>
|
||||
<tr>
|
||||
<th>Parameter</th>
|
||||
<th>Required</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead><tbody>
|
||||
<tr>
|
||||
<td>Album</td>
|
||||
<td>true</td>
|
||||
<td>string</td>
|
||||
<td>Album title</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Artist</td>
|
||||
<td>true</td>
|
||||
<td>string</td>
|
||||
<td>Artist name</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Name</td>
|
||||
<td>true</td>
|
||||
<td>string</td>
|
||||
<td>Song title</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>ItemType</td>
|
||||
<td>true</td>
|
||||
<td>string</td>
|
||||
<td>Will only scrobble type 'Audio'</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>ClientName</td>
|
||||
<td>false</td>
|
||||
<td>string</td>
|
||||
<td>TBD</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>DeviceId</td>
|
||||
<td>false</td>
|
||||
<td>string</td>
|
||||
<td>TBD</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>DeviceName</td>
|
||||
<td>false</td>
|
||||
<td>string</td>
|
||||
<td>TBD</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>IsAutomated</td>
|
||||
<td>false</td>
|
||||
<td>bool</td>
|
||||
<td>TBD</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>IsPaused</td>
|
||||
<td>false</td>
|
||||
<td>bool</td>
|
||||
<td>TBD</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>ItemId</td>
|
||||
<td>false</td>
|
||||
<td>string</td>
|
||||
<td>TBD</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>MediaSourceId</td>
|
||||
<td>false</td>
|
||||
<td>string</td>
|
||||
<td>TBD</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>NotificationType</td>
|
||||
<td>false</td>
|
||||
<td>string</td>
|
||||
<td>TBD</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Overview</td>
|
||||
<td>false</td>
|
||||
<td>string</td>
|
||||
<td>TBD</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>PlaybackPosition</td>
|
||||
<td>false</td>
|
||||
<td>string</td>
|
||||
<td>TBD</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>PlaybackPositionTicks</td>
|
||||
<td>false</td>
|
||||
<td>int</td>
|
||||
<td>TBD</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Provider_musicbrainzalbum</td>
|
||||
<td>false</td>
|
||||
<td>string</td>
|
||||
<td>TBD</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Provider_musicbrainzalbumartist</td>
|
||||
<td>false</td>
|
||||
<td>string</td>
|
||||
<td>TBD</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Provider_musicbrainzartist</td>
|
||||
<td>false</td>
|
||||
<td>string</td>
|
||||
<td>TBD</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Provider_musicbrainzreleasegroup</td>
|
||||
<td>false</td>
|
||||
<td>string</td>
|
||||
<td>TBD</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Provider_musicbrainztrack</td>
|
||||
<td>false</td>
|
||||
<td>string</td>
|
||||
<td>TBD</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>RunTime</td>
|
||||
<td>false</td>
|
||||
<td>string</td>
|
||||
<td>TBD</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>RunTimeTicks</td>
|
||||
<td>false</td>
|
||||
<td>int</td>
|
||||
<td>TBD</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>ServerId</td>
|
||||
<td>false</td>
|
||||
<td>string</td>
|
||||
<td>TBD</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>ServerName</td>
|
||||
<td>false</td>
|
||||
<td>string</td>
|
||||
<td>TBD</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>ServerUrl</td>
|
||||
<td>false</td>
|
||||
<td>string</td>
|
||||
<td>TBD</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>ServerVersion</td>
|
||||
<td>false</td>
|
||||
<td>string</td>
|
||||
<td>TBD</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Timestamp</td>
|
||||
<td>false</td>
|
||||
<td>string</td>
|
||||
<td>TBD</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>UserId</td>
|
||||
<td>false</td>
|
||||
<td>TBD</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Username</td>
|
||||
<td>false</td>
|
||||
<td>TBD</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>UtcTimestamp</td>
|
||||
<td>false</td>
|
||||
<td>TBD</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Year</td>
|
||||
<td>false</td>
|
||||
<td>int</td>
|
||||
<td>TBD</td>
|
||||
</tr>
|
||||
</tbody></table>
|
||||
<h2 id='post-v1-ingress-multiscrobbler'>POST v1/ingress/multiscrobbler</h2>
|
||||
<blockquote>
|
||||
<p>Submit a scrobble:</p>
|
||||
</blockquote>
|
||||
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="s2">"https://goscrobble.com/api/v1/ingress/multiscrobbler"</span> <span class="se">\</span>
|
||||
<span class="nt">-H</span> <span class="s2">"Content-Type: application/json"</span> <span class="se">\</span>
|
||||
<span class="nt">-H</span> <span class="s2">"Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhZG1pbiI6ZmFsc2UsImVtYWlsIjoidGVzdEB0ZXN0LmNvbSIsImV4cCI6MTY0MTAwMjUxOSwiaWF0IjoxNjQwMzk3NzE5LCJtb2QiOnRydWUsI"</span> <span class="se">\</span>
|
||||
<span class="nt">-X</span> POST <span class="se">\</span>
|
||||
<span class="nt">--data</span> <span class="s1">'{"Track":"<Full JSON structure located in ingress_multiscrobbler.go>", "Album":"Best Album","Artist":["Best Artist1", "Best Artist2"]}'</span>
|
||||
</code></pre></div>
|
||||
<blockquote>
|
||||
<p>Response:</p>
|
||||
</blockquote>
|
||||
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
||||
</span><span class="nl">"message"</span><span class="p">:</span><span class="w"> </span><span class="s2">"success"</span><span class="w">
|
||||
</span><span class="p">}</span><span class="w">
|
||||
</span></code></pre></div>
|
||||
<p>Adds a scrobble from MultiScrobbler into the database. Please view <code>type MultiScrobblerRequest struct</code> in ingress_multiscrobbler.go for the full request format.</p>
|
||||
|
||||
<aside class="notice">
|
||||
Light rate-limiting applies
|
||||
</aside>
|
||||
<h3 id='http-request-2'>HTTP Request</h3>
|
||||
<p><code>POST https://goscrobble.com/api/v1/ingress/multiscrobbler</code></p>
|
||||
<h3 id='query-parameters-2'>Query Parameters</h3>
|
||||
<table><thead>
|
||||
<tr>
|
||||
<th>Parameter</th>
|
||||
<th>Required</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead><tbody>
|
||||
<tr>
|
||||
<td>Album</td>
|
||||
<td>true</td>
|
||||
<td>string</td>
|
||||
<td>Album title</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Artist</td>
|
||||
<td>true</td>
|
||||
<td>array</td>
|
||||
<td>Array of Artist names</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Track</td>
|
||||
<td>true</td>
|
||||
<td>string</td>
|
||||
<td>Song title</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>PlayedAt</td>
|
||||
<td>true</td>
|
||||
<td>int</td>
|
||||
<td>Unix Timestamp of scrobble time</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Duration</td>
|
||||
<td>true</td>
|
||||
<td>int</td>
|
||||
<td>Song length in seconds</td>
|
||||
</tr>
|
||||
</tbody></table>
|
||||
<h1 id='authentication'>Authentication</h1><h2 id='post-v1-login'>POST v1/login</h2>
|
||||
<blockquote>
|
||||
<p>To obtain a JWT token (Replace default credentials):</p>
|
||||
</blockquote>
|
||||
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="s2">"https://goscrobble.com/api/v1/login"</span> <span class="se">\</span>
|
||||
<span class="nt">-H</span> <span class="s2">"Content-Type: application/json"</span> <span class="se">\</span>
|
||||
<span class="nt">-X</span> POST <span class="se">\</span>
|
||||
<span class="nt">--data</span> <span class="s1">'{"username":"abc","password":"def"}'</span>
|
||||
</code></pre></div>
|
||||
<blockquote>
|
||||
|
|
@ -387,6 +714,10 @@
|
|||
</span><span class="p">}</span><span class="w">
|
||||
</span></code></pre></div>
|
||||
<p>This endpoint is used to authenticate and retrieve a JWT token.</p>
|
||||
|
||||
<aside class="notice">
|
||||
Standard rate-limiting applies
|
||||
</aside>
|
||||
<h3 id='http-request'>HTTP Request</h3>
|
||||
<p><code>POST https://goscrobble.com/api/v1/login</code></p>
|
||||
<h3 id='query-parameters'>Query Parameters</h3>
|
||||
|
|
@ -408,12 +739,13 @@
|
|||
<td>Account password</td>
|
||||
</tr>
|
||||
</tbody></table>
|
||||
<h2 id='v1-register'>v1/register</h2>
|
||||
<h2 id='post-v1-register'>POST v1/register</h2>
|
||||
<blockquote>
|
||||
<p>Create a new account (Replace default credentials):</p>
|
||||
</blockquote>
|
||||
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="s2">"https://goscrobble.com/api/v1/register"</span> <span class="se">\</span>
|
||||
<span class="nt">-H</span> <span class="s2">"Content-Type: application/json"</span> <span class="se">\</span>
|
||||
<span class="nt">-X</span> POST <span class="se">\</span>
|
||||
<span class="nt">--data</span> <span class="s1">'{"email": "test@test.com", "username":"abc","password":"def"}'</span>
|
||||
</code></pre></div>
|
||||
<blockquote>
|
||||
|
|
@ -424,6 +756,10 @@
|
|||
</span><span class="p">}</span><span class="w">
|
||||
</span></code></pre></div>
|
||||
<p>If the server has REGISTRATION_ENABLED=true set, this endpoint will allow you to create a new account. Password must be at least 8 characters long.</p>
|
||||
|
||||
<aside class="notice">
|
||||
Heavy rate-limiting applies
|
||||
</aside>
|
||||
<h3 id='http-request-2'>HTTP Request</h3>
|
||||
<p><code>POST https://goscrobble.com/api/v1/register</code></p>
|
||||
<h3 id='query-parameters-2'>Query Parameters</h3>
|
||||
|
|
@ -450,12 +786,13 @@
|
|||
<td>Account password</td>
|
||||
</tr>
|
||||
</tbody></table>
|
||||
<h2 id='v1-sendreset'>v1/sendreset</h2>
|
||||
<h2 id='post-v1-sendreset'>POST v1/sendreset</h2>
|
||||
<blockquote>
|
||||
<p>Trigger a password reset email:</p>
|
||||
</blockquote>
|
||||
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="s2">"https://goscrobble.com/api/v1/sendreset"</span> <span class="se">\</span>
|
||||
<span class="nt">-H</span> <span class="s2">"Content-Type: application/json"</span> <span class="se">\</span>
|
||||
<span class="nt">-X</span> POST <span class="se">\</span>
|
||||
<span class="nt">--data</span> <span class="s1">'{"email":"test@test.com"}'</span>
|
||||
</code></pre></div>
|
||||
<blockquote>
|
||||
|
|
@ -466,6 +803,10 @@
|
|||
</span><span class="p">}</span><span class="w">
|
||||
</span></code></pre></div>
|
||||
<p>This endpoint triggers a password reset email to be sent to the email on an account.</p>
|
||||
|
||||
<aside class="notice">
|
||||
Heavy rate-limiting applies
|
||||
</aside>
|
||||
<h3 id='http-request-3'>HTTP Request</h3>
|
||||
<p><code>POST https://goscrobble.com/api/v1/sendreset</code></p>
|
||||
<h3 id='query-parameters-3'>Query Parameters</h3>
|
||||
|
|
@ -482,12 +823,13 @@
|
|||
<td>Account username</td>
|
||||
</tr>
|
||||
</tbody></table>
|
||||
<h2 id='v1-resetpassword'>v1/resetpassword</h2>
|
||||
<h2 id='post-v1-resetpassword'>POST v1/resetpassword</h2>
|
||||
<blockquote>
|
||||
<p>Trigger a password reset email:</p>
|
||||
</blockquote>
|
||||
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="s2">"https://goscrobble.com/api/v1/resetpassword"</span> <span class="se">\</span>
|
||||
<span class="nt">-H</span> <span class="s2">"Content-Type: application/json"</span> <span class="se">\</span>
|
||||
<span class="nt">-X</span> POST <span class="se">\</span>
|
||||
<span class="nt">--data</span> <span class="s1">'{"token":"abcdefghijklmnopqrstuvwxyz", "password": "Hunter1"}'</span>
|
||||
</code></pre></div>
|
||||
<blockquote>
|
||||
|
|
@ -498,6 +840,10 @@
|
|||
</span><span class="p">}</span><span class="w">
|
||||
</span></code></pre></div>
|
||||
<p>This endpoint confirms a password reset with a valid hash from the reset email. You must call v1/sendreset first and obtain the hash.</p>
|
||||
|
||||
<aside class="notice">
|
||||
Heavy rate-limiting applies
|
||||
</aside>
|
||||
<h3 id='http-request-4'>HTTP Request</h3>
|
||||
<p><code>POST https://goscrobble.com/api/v1/resetpassword</code></p>
|
||||
<h3 id='query-parameters-4'>Query Parameters</h3>
|
||||
|
|
@ -518,6 +864,108 @@
|
|||
<td>true</td>
|
||||
<td>New account password</td>
|
||||
</tr>
|
||||
</tbody></table>
|
||||
<h2 id='post-v1-refresh'>POST v1/refresh</h2>
|
||||
<blockquote>
|
||||
<p>Fetch a new JWT with a refresh token:</p>
|
||||
</blockquote>
|
||||
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="s2">"https://goscrobble.com/api/v1/refresh"</span> <span class="se">\</span>
|
||||
<span class="nt">-H</span> <span class="s2">"Content-Type: application/json"</span> <span class="se">\</span>
|
||||
<span class="nt">-X</span> POST <span class="se">\</span>
|
||||
<span class="nt">--data</span> <span class="s1">'{"token":"abcdefghijklmnopqrstuvwxyz"}'</span>
|
||||
</code></pre></div>
|
||||
<blockquote>
|
||||
<p>Response:</p>
|
||||
</blockquote>
|
||||
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
||||
</span><span class="nl">"token"</span><span class="p">:</span><span class="w"> </span><span class="s2">"eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhZG1pbiI6ZmFsc2UsImVtYWlsIjoidGVzdEB0ZXN0LmNvbSIsImV4cCI6MTY0MTAwMjUxOSwiaWF0IjoxNjQwMzk3NzE5LCJtb2QiOnRydWUsInJlZnJlc2hfZXhwIjoxNjQxMDAyNTE5LCJyZWZyZXNoX3Rva2VuIjoiYWJjZGVmZ2hqaWtsbW5vcHF3ZXJ0dXZ3eHl6Iiwic3ViIjoiNDE4ZmRkZmItOGIxYi01MWFiLTliZHMtNGZnMDhjYTYzY2ZmIiwidXNlcm5hbWUiOiJ0ZXN0In0.fuPXjQ7IzNyttgIKpdS4-KBQ-QeHTl-BfgYkSnMCmpVrBunzMrSwr1RzxI7Xg2WWF-FHtW3Bnv9RpSqLDN4F2g"</span><span class="w">
|
||||
</span><span class="p">}</span><span class="w">
|
||||
</span></code></pre></div>
|
||||
<p>Returns a new JWT token by passing a refresh token.</p>
|
||||
|
||||
<aside class="notice">
|
||||
Standard rate-limiting applies
|
||||
</aside>
|
||||
<h3 id='http-request-5'>HTTP Request</h3>
|
||||
<p><code>POST https://goscrobble.com/api/v1/refresh</code></p>
|
||||
<h3 id='query-parameters-5'>Query Parameters</h3>
|
||||
<table><thead>
|
||||
<tr>
|
||||
<th>Parameter</th>
|
||||
<th>Required</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead><tbody>
|
||||
<tr>
|
||||
<td>token</td>
|
||||
<td>true</td>
|
||||
<td>Refresh token from previously issued JWT</td>
|
||||
</tr>
|
||||
</tbody></table>
|
||||
<h1 id='admin-endpoints'>Admin Endpoints</h1>
|
||||
<aside class="warning">
|
||||
An admin JWT token is required for the below endpoints
|
||||
</aside>
|
||||
<h2 id='get-v1-config'>GET v1/config</h2>
|
||||
<blockquote>
|
||||
<p>Fetch configuration values:</p>
|
||||
</blockquote>
|
||||
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="s2">"https://goscrobble.com/api/v1/config"</span> <span class="se">\</span>
|
||||
<span class="nt">-H</span> <span class="s2">"Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhZG1pbiI6ZmFsc2UsImVtYWlsIjoidGVzdEB0ZXN0LmNvbSIsImV4cCI6MTY0MTAwMjUxOSwiaWF0IjoxNjQwMzk3NzE5LCJtb2QiOnRydWUsI"</span>
|
||||
</code></pre></div>
|
||||
<blockquote>
|
||||
<p>Response:</p>
|
||||
</blockquote>
|
||||
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
||||
</span><span class="nl">"SPOTIFY_API_ID"</span><span class="p">:</span><span class="w"> </span><span class="s2">"abc"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"SPOTIFY_API_SECRET"</span><span class="p">:</span><span class="w"> </span><span class="s2">"def"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"REGISTRATION_ENABLED"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
|
||||
</span><span class="p">}</span><span class="w">
|
||||
</span></code></pre></div>
|
||||
<p>Fetch instance configuration values.</p>
|
||||
|
||||
<aside class="notice">
|
||||
Standard rate-limiting applies
|
||||
</aside>
|
||||
<h3 id='http-request'>HTTP Request</h3>
|
||||
<p><code>GET https://goscrobble.com/api/v1/config</code></p>
|
||||
<h2 id='post-v1-config'>POST v1/config</h2>
|
||||
<blockquote>
|
||||
<p>Update a configuration parameter:</p>
|
||||
</blockquote>
|
||||
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="s2">"https://goscrobble.com/api/v1/config"</span> <span class="se">\</span>
|
||||
<span class="nt">-H</span> <span class="s2">"Content-Type: application/json"</span> <span class="se">\</span>
|
||||
<span class="nt">-H</span> <span class="s2">"Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhZG1pbiI6ZmFsc2UsImVtYWlsIjoidGVzdEB0ZXN0LmNvbSIsImV4cCI6MTY0MTAwMjUxOSwiaWF0IjoxNjQwMzk3NzE5LCJtb2QiOnRydWUsI"</span> <span class="se">\</span>
|
||||
<span class="nt">-X</span> POST <span class="se">\</span>
|
||||
<span class="nt">--data</span> <span class="s1">'{"SPOTIFY_API_ID":"notarealapikey","SPOTIFY_API_SECRET":"notarealsecret"}'</span>
|
||||
</code></pre></div>
|
||||
<blockquote>
|
||||
<p>Response:</p>
|
||||
</blockquote>
|
||||
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
||||
</span><span class="nl">"message"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Config updated successfully"</span><span class="w">
|
||||
</span><span class="p">}</span><span class="w">
|
||||
</span></code></pre></div>
|
||||
<p>Updates instance configuration values.</p>
|
||||
|
||||
<aside class="notice">
|
||||
Standard rate-limiting applies
|
||||
</aside>
|
||||
<h3 id='http-request-2'>HTTP Request</h3>
|
||||
<p><code>POST https://goscrobble.com/api/v1/config</code></p>
|
||||
<h3 id='query-parameters'>Query Parameters</h3>
|
||||
<table><thead>
|
||||
<tr>
|
||||
<th>Parameter</th>
|
||||
<th>Required</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead><tbody>
|
||||
<tr>
|
||||
<td>key</td>
|
||||
<td>true</td>
|
||||
<td>Array of key/value pairs to update. See example.</td>
|
||||
</tr>
|
||||
</tbody></table>
|
||||
|
||||
</div>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue