|
384 | 384 | <li>
|
385 | 385 | <a href="#authentication" class="toc-h1 toc-link" data-title="Authentication">Authentication</a>
|
386 | 386 | </li>
|
| 387 | + <li> |
| 388 | + <a href="#testing" class="toc-h1 toc-link" data-title="Testing">Testing</a> |
| 389 | + </li> |
387 | 390 | <li>
|
388 | 391 | <a href="#security" class="toc-h1 toc-link" data-title="Security">Security</a>
|
389 | 392 | </li>
|
@@ -626,6 +629,12 @@ <h1 id='authentication'>Authentication</h1>
|
626 | 629 | <aside class="notice">
|
627 | 630 | Rolled Secret Keys will remain valid for the duration specified before they are permanently expired.
|
628 | 631 | </aside>
|
| 632 | +<h1 id='testing'>Testing</h1> |
| 633 | +<p>API requests may be tested in a live environment simply by using the API Test Key provided in the <a href="https://developer.paket.tv">Paket Developer Portal</a>. Test keys begin with the prefix <code>test_sk</code> and inherit the same behaviors as live API Secret Keys, save that they call test responses. </p> |
| 634 | + |
| 635 | +<p>Test API requests are validated identically to live requests and although the response schema are identical to live requests, the responses themselves are dynamically generated. </p> |
| 636 | + |
| 637 | +<p>The <code>Paket-Response-Type: Test</code> header indicates whether or not the response is via the API Test Key.</p> |
629 | 638 | <h1 id='security'>Security</h1>
|
630 | 639 | <p>Securing API requests is critical to ensure data integrity. The Paket API employs the following methods to ensure that requests made to its API are authenticated and secure:</p>
|
631 | 640 |
|
@@ -754,13 +763,17 @@ <h3 id='core-api-api-status-the-status-object'>The Status Object</h3>
|
754 | 763 | <p>The Status Object</p>
|
755 | 764 | </blockquote>
|
756 | 765 | <div class="highlight"><pre class="highlight plaintext"><code>{
|
757 |
| - "message": "The API is healthy!" |
| 766 | + "message": "The API is healthy!", |
| 767 | + "client_id: "fab3d02606122a08" |
758 | 768 | }
|
759 | 769 | </code></pre></div>
|
760 | 770 | <p><strong>Attributes</strong></p>
|
761 | 771 |
|
762 | 772 | <p><strong><code>message</code></strong> <span style='margin: 0 5px;font-size:.9em'>string</span><br>
|
763 |
| -The API Status.</p> |
| 773 | +The API Status message.</p> |
| 774 | + |
| 775 | +<p><strong><code>client_id</code></strong> <span style='margin: 0 5px;font-size:.9em'>string</span><br> |
| 776 | +The unique identifier of the requesting Client.</p> |
764 | 777 | <h3 id='core-api-api-status-retrieve-api-status'>Retrieve API Status</h3>
|
765 | 778 | <blockquote>
|
766 | 779 | <p>GET https://api.paket.tv/v1</p>
|
@@ -1256,7 +1269,7 @@ <h3 id='upnext-api-sessions-get-an-aggregated-list'>Get an Aggregated List</h3>
|
1256 | 1269 | <p><strong>Parameters</strong></p>
|
1257 | 1270 |
|
1258 | 1271 | <p><strong><code>limit</code></strong> <span style='margin: 0 5px;font-size:.9em'>integer</span><br>
|
1259 |
| -Optional. Limits items returned (default is <code>50</code>).</p> |
| 1272 | +Optional. Limits items returned (default is <code>50</code>, maximum is <code>200</code>).</p> |
1260 | 1273 |
|
1261 | 1274 | <p><strong><code>next_key</code></strong> <span style='margin: 0 5px;font-size:.9em'>integer</span><br>
|
1262 | 1275 | Optional. Key returned in previous call if <a href="#pagination">additional items</a> are available.</p>
|
@@ -1317,7 +1330,7 @@ <h3 id='upnext-api-sessions-get-a-specific-list'>Get a Specific List</h3>
|
1317 | 1330 | <p><strong>Parameters</strong></p>
|
1318 | 1331 |
|
1319 | 1332 | <p><strong><code>limit</code></strong> <span style='margin: 0 5px;font-size:.9em'>integer</span><br>
|
1320 |
| -Optional. Limits items returned (default is <code>50</code>).</p> |
| 1333 | +Optional. Limits items returned (default is <code>50</code>, maximum is <code>200</code>).</p> |
1321 | 1334 |
|
1322 | 1335 | <p><strong><code>next_key</code></strong> <span style='margin: 0 5px;font-size:.9em'>integer</span><br>
|
1323 | 1336 | Optional. Key returned in previous call if <a href="#pagination">additional items</a> are available.</p>
|
@@ -1363,7 +1376,7 @@ <h3 id='upnext-api-sessions-get-session-participants'>Get Session Participants</
|
1363 | 1376 | <p><strong>Parameters</strong></p>
|
1364 | 1377 |
|
1365 | 1378 | <p><strong><code>limit</code></strong> <span style='margin: 0 5px;font-size:.9em'>integer</span><br>
|
1366 |
| -Optional. Limits items returned (default is <code>50</code>).</p> |
| 1379 | +Optional. Limits items returned (default and maximum is <code>50</code>).</p> |
1367 | 1380 |
|
1368 | 1381 | <p><strong><code>next_key</code></strong> <span style='margin: 0 5px;font-size:.9em'>integer</span><br>
|
1369 | 1382 | Optional. Key returned in previous call if <a href="#pagination">additional items</a> are available.</p>
|
@@ -1673,7 +1686,7 @@ <h3 id='upnext-api-participants-get-a-participant-list'>Get a Participant List</
|
1673 | 1686 | <p><strong>Parameters</strong></p>
|
1674 | 1687 |
|
1675 | 1688 | <p><strong><code>limit</code></strong> <span style='margin: 0 5px;font-size:.9em'>integer</span><br>
|
1676 |
| -Optional. Limits items returned (default is <code>50</code>).</p> |
| 1689 | +Optional. Limits items returned (default is <code>50</code>, maximum is <code>200</code>).</p> |
1677 | 1690 |
|
1678 | 1691 | <p><strong><code>next_key</code></strong> <span style='margin: 0 5px;font-size:.9em'>integer</span><br>
|
1679 | 1692 | Optional. Key returned in previous call if <a href="#pagination">additional items</a> are available.</p>
|
|
0 commit comments