diff options
Diffstat (limited to 'vtuber-captcha.html')
| -rw-r--r-- | vtuber-captcha.html | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/vtuber-captcha.html b/vtuber-captcha.html index eacb0d9..0357f12 100644 --- a/vtuber-captcha.html +++ b/vtuber-captcha.html @@ -1,4 +1,4 @@ -<!DOCTYPE html SYSTEM "about:legacy-compat"><html lang="en-US" data-colors-preset="contrast" data-primary-color="#307FFF"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="robots" content="noindex"> <meta name="built-on" content="2023-12-15T23:52:21.656668549"><meta name="build-number" content="${buildNumber}"> <title>VTuber Captcha | Project Knowledge Base</title><script id="virtual-toc-data" type="application/json">[{"id":"available-endpoints","level":0,"title":"Available Endpoints","anchor":"#available-endpoints"},{"id":"affiliation-org","level":0,"title":"/affiliation/\u003corg\u003e","anchor":"#affiliation-org"},{"id":"authenticating-answers-against-the-server","level":0,"title":"Authenticating Answers Against The Server","anchor":"#authenticating-answers-against-the-server"},{"id":"supported-keywords","level":0,"title":"Supported Keywords","anchor":"#supported-keywords"},{"id":"organization","level":0,"title":"Organization","anchor":"#organization"}]</script><script id="topic-shortcuts" type="application/json"></script><link href="https://resources.jetbrains.com/writerside/apidoc/6.6.6-b205/app.css" rel="stylesheet"> <link rel="apple-touch-icon" sizes="180x180" href="https://jetbrains.com/apple-touch-icon.png"><link rel="icon" type="image/png" sizes="32x32" href="https://jetbrains.com/favicon-32x32.png"><link rel="icon" type="image/png" sizes="16x16" href="https://jetbrains.com/favicon-16x16.png"><link rel="manifest" href="https://jetbrains.com/site.webmanifest"><link rel="mask-icon" href="https://jetbrains.com/safari-pinned-tab.svg" color="#000000"><meta name="msapplication-TileColor" content="#000000"/><meta name="msapplication-TileImage" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-144x144.png"/><meta name="msapplication-square70x70logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-70x70.png"/><meta name="msapplication-square150x150logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-150x150.png"/><meta name="msapplication-wide310x150logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-310x150.png"/><meta name="msapplication-square310x310logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-310x310.png"/> <meta name="image" content=""><!-- Open Graph --><meta property="og:title" content="VTuber Captcha | Project Knowledge Base"/><meta property="og:description" content=""/><meta property="og:image" content=""/><meta property="og:site_name" content="Project Knowledge Base Help"/><meta property="og:type" content="website"/><meta property="og:locale" content="en_US"/><meta property="og:url" content="vtuber-captcha.html"/><!-- End Open Graph --><!-- Twitter Card --><meta name="twitter:card" content="summary_large_image"><meta name="twitter:site" content=""><meta name="twitter:title" content="VTuber Captcha | Project Knowledge Base"><meta name="twitter:description" content=""><meta name="twitter:creator" content=""><meta name="twitter:image:src" content=""><!-- End Twitter Card --><!-- Schema.org WebPage --><script type="application/ld+json"> { "@context": "http://schema.org", "@type": "WebPage", "@id": "vtuber-captcha.html#webpage", "url": "vtuber-captcha.html", "name": "VTuber Captcha | Project Knowledge Base", "description": "", "image": "", "inLanguage":"en-US" }</script><!-- End Schema.org --><!-- Schema.org WebSite --><script type="application/ld+json"> { "@type": "WebSite", "@id": "/#website", "url": "/", "name": "Project Knowledge Base Help" }</script><!-- End Schema.org --></head> <body data-id="VTuber-Captcha" data-main-title="VTuber Captcha" data-article-props="{"seeAlsoStyle":"links"}" data-template="article" data-breadcrumbs="" > <div class="wrapper"><main class="panel _main"><header class="panel__header"><div class="container"><h3>Project Knowledge Base Help</h3><div class="panel-trigger"></div></div></header><section class="panel__content"><div class="container"><article class="article" data-shortcut-switcher="inactive"><h1 data-toc="VTuber-Captcha" id="VTuber-Captcha.md">VTuber Captcha</h1> <p id="64dbd8f7_1749">A simple web API that serves VTuber related CAPTCHAs including server-side verification. Bring your own frontend to display the data.</p><section class="chapter"><h2 id="available-endpoints" data-toc="available-endpoints" >Available Endpoints</h2><p id="64dbd8f7_1750">The base URL or the API currently is: <code class="code" id="64dbd8f7_1751">https://vtuber-captcha.vercel.app/api</code></p><p id="64dbd8f7_1752">Below are the current API endpoints supported: <a href="https://github.com/pinapelz/vtuber-captcha/wiki/Authenticating-Answers-Against-the-API" id="64dbd8f7_1753" data-external="true" rel="noopener noreferrer" >Authenticating Against the API</a></p></section><section class="chapter"><h2 id="affiliation-org" data-toc="affiliation-org" >/affiliation/<org></h2><p id="64dbd8f7_1754">Returns a captcha asking user to identify which of the VTubers are affiliated with a particular organization or group</p><p id="64dbd8f7_1755"><span class="control" id="64dbd8f7_1756">Path Parameters</span></p><ul class="list _ul" id="64dbd8f7_1757"><li class="list__item" id="64dbd8f7_1758"><p><code class="code" id="64dbd8f7_1759"><org></code>: Refer to <a href="https://github.com/pinapelz/vtuber-captcha/wiki/Supported-Terms#organizations" id="64dbd8f7_1760" data-external="true" rel="noopener noreferrer" >organization page</a> for a list of supported terms <span class="control" id="64dbd8f7_1761">Query Parameters</span></p></li><li class="list__item" id="64dbd8f7_1762"><p><code class="code" id="64dbd8f7_1763">server_auth</code>: false if answers to captcha should be sent to response, true if you would like the API to store the answer and authenticate against it. </p><ul class="list _ul" id="64dbd8f7_1764"><li class="list__item" id="64dbd8f7_1765"><p>Default: <code class="code" id="64dbd8f7_1766">false</code></p></li><li class="list__item" id="64dbd8f7_1767"><p>Enums: <code class="code" id="64dbd8f7_1768">true, false</code></p></li></ul></li></ul></section><section class="chapter"><h2 id="authenticating-answers-against-the-server" data-toc="authenticating-answers-against-the-server" >Authenticating Answers Against The Server</h2><p id="64dbd8f7_1769">The API supports server-side verification meaning that the answer to the CAPTCHA is never sent to you after making the initial request.</p><p id="64dbd8f7_1770">Instead, each request will be assigned a session-token which uniquely identifies the CAPTCHA. The server then saves the answer to the CAPTCHA. This makes it safe for you to directly call the API client-side from a frontend without the need for a middle-man to store the answer.</p><p id="64dbd8f7_1771">To authenticate answers against the API. You need to specify the query parameter <code class="code" id="64dbd8f7_1772">?server_auth=true</code></p><p id="64dbd8f7_1773"><span class="control" id="64dbd8f7_1774">Example Response with <code class="code" id="64dbd8f7_1775">?server_auth=true</code></span></p><div class="code-block" data-lang="none" > +<!DOCTYPE html SYSTEM "about:legacy-compat"><html lang="en-US" data-colors-preset="contrast" data-primary-color="#307FFF"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="robots" content="noindex"> <meta name="built-on" content="2023-12-16T15:53:06.914162961"><meta name="build-number" content="${buildNumber}"> <title>VTuber Captcha | Project Knowledge Base</title><script id="virtual-toc-data" type="application/json">[{"id":"available-endpoints","level":0,"title":"Available Endpoints","anchor":"#available-endpoints"},{"id":"affiliation-org","level":0,"title":"/affiliation/\u003corg\u003e","anchor":"#affiliation-org"},{"id":"authenticating-answers-against-the-server","level":0,"title":"Authenticating Answers Against The Server","anchor":"#authenticating-answers-against-the-server"},{"id":"supported-keywords","level":0,"title":"Supported Keywords","anchor":"#supported-keywords"},{"id":"organization","level":0,"title":"Organization","anchor":"#organization"}]</script><script id="topic-shortcuts" type="application/json"></script><link href="https://resources.jetbrains.com/writerside/apidoc/6.6.6-b205/app.css" rel="stylesheet"> <link rel="apple-touch-icon" sizes="180x180" href="https://jetbrains.com/apple-touch-icon.png"><link rel="icon" type="image/png" sizes="32x32" href="https://jetbrains.com/favicon-32x32.png"><link rel="icon" type="image/png" sizes="16x16" href="https://jetbrains.com/favicon-16x16.png"><link rel="manifest" href="https://jetbrains.com/site.webmanifest"><link rel="mask-icon" href="https://jetbrains.com/safari-pinned-tab.svg" color="#000000"><meta name="msapplication-TileColor" content="#000000"/><meta name="msapplication-TileImage" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-144x144.png"/><meta name="msapplication-square70x70logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-70x70.png"/><meta name="msapplication-square150x150logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-150x150.png"/><meta name="msapplication-wide310x150logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-310x150.png"/><meta name="msapplication-square310x310logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-310x310.png"/> <meta name="image" content=""><!-- Open Graph --><meta property="og:title" content="VTuber Captcha | Project Knowledge Base"/><meta property="og:description" content=""/><meta property="og:image" content=""/><meta property="og:site_name" content="Project Knowledge Base Help"/><meta property="og:type" content="website"/><meta property="og:locale" content="en_US"/><meta property="og:url" content="vtuber-captcha.html"/><!-- End Open Graph --><!-- Twitter Card --><meta name="twitter:card" content="summary_large_image"><meta name="twitter:site" content=""><meta name="twitter:title" content="VTuber Captcha | Project Knowledge Base"><meta name="twitter:description" content=""><meta name="twitter:creator" content=""><meta name="twitter:image:src" content=""><!-- End Twitter Card --><!-- Schema.org WebPage --><script type="application/ld+json"> { "@context": "http://schema.org", "@type": "WebPage", "@id": "vtuber-captcha.html#webpage", "url": "vtuber-captcha.html", "name": "VTuber Captcha | Project Knowledge Base", "description": "", "image": "", "inLanguage":"en-US" }</script><!-- End Schema.org --><!-- Schema.org WebSite --><script type="application/ld+json"> { "@type": "WebSite", "@id": "/#website", "url": "/", "name": "Project Knowledge Base Help" }</script><!-- End Schema.org --></head> <body data-id="VTuber-Captcha" data-main-title="VTuber Captcha" data-article-props="{"seeAlsoStyle":"links"}" data-template="article" data-breadcrumbs="" > <div class="wrapper"><main class="panel _main"><header class="panel__header"><div class="container"><h3>Project Knowledge Base Help</h3><div class="panel-trigger"></div></div></header><section class="panel__content"><div class="container"><article class="article" data-shortcut-switcher="inactive"><h1 data-toc="VTuber-Captcha" id="VTuber-Captcha.md">VTuber Captcha</h1> <p id="5be93111_1726">A simple web API that serves VTuber related CAPTCHAs including server-side verification. Bring your own frontend to display the data.</p><section class="chapter"><h2 id="available-endpoints" data-toc="available-endpoints" >Available Endpoints</h2><p id="5be93111_1727">The base URL or the API currently is: <code class="code" id="5be93111_1728">https://vtuber-captcha.vercel.app/api</code></p><p id="5be93111_1729">Below are the current API endpoints supported: <a href="https://github.com/pinapelz/vtuber-captcha/wiki/Authenticating-Answers-Against-the-API" id="5be93111_1730" data-external="true" rel="noopener noreferrer" >Authenticating Against the API</a></p></section><section class="chapter"><h2 id="affiliation-org" data-toc="affiliation-org" >/affiliation/<org></h2><p id="5be93111_1731">Returns a captcha asking user to identify which of the VTubers are affiliated with a particular organization or group</p><p id="5be93111_1732"><span class="control" id="5be93111_1733">Path Parameters</span></p><ul class="list _ul" id="5be93111_1734"><li class="list__item" id="5be93111_1735"><p><code class="code" id="5be93111_1736"><org></code>: Refer to <a href="https://github.com/pinapelz/vtuber-captcha/wiki/Supported-Terms#organizations" id="5be93111_1737" data-external="true" rel="noopener noreferrer" >organization page</a> for a list of supported terms <span class="control" id="5be93111_1738">Query Parameters</span></p></li><li class="list__item" id="5be93111_1739"><p><code class="code" id="5be93111_1740">server_auth</code>: false if answers to captcha should be sent to response, true if you would like the API to store the answer and authenticate against it. </p><ul class="list _ul" id="5be93111_1741"><li class="list__item" id="5be93111_1742"><p>Default: <code class="code" id="5be93111_1743">false</code></p></li><li class="list__item" id="5be93111_1744"><p>Enums: <code class="code" id="5be93111_1745">true, false</code></p></li></ul></li></ul></section><section class="chapter"><h2 id="authenticating-answers-against-the-server" data-toc="authenticating-answers-against-the-server" >Authenticating Answers Against The Server</h2><p id="5be93111_1746">The API supports server-side verification meaning that the answer to the CAPTCHA is never sent to you after making the initial request.</p><p id="5be93111_1747">Instead, each request will be assigned a session-token which uniquely identifies the CAPTCHA. The server then saves the answer to the CAPTCHA. This makes it safe for you to directly call the API client-side from a frontend without the need for a middle-man to store the answer.</p><p id="5be93111_1748">To authenticate answers against the API. You need to specify the query parameter <code class="code" id="5be93111_1749">?server_auth=true</code></p><p id="5be93111_1750"><span class="control" id="5be93111_1751">Example Response with <code class="code" id="5be93111_1752">?server_auth=true</code></span></p><div class="code-block" data-lang="none" > { "category": "affiliation", "onFail": { @@ -90,11 +90,11 @@ "session": "GUQkquh03dwF84EAxif_EA", "title": "Select all the VTuber affiliated with Hololive" } -</div><p id="64dbd8f7_1777">To check your answers against the API. Send <code class="code" id="64dbd8f7_1778">session</code> token and the <code class="code" id="64dbd8f7_1779">id</code> of each selected element as a string comma separated as part of a data payload to <code class="code" id="64dbd8f7_1780">/api/verify</code></p><p id="64dbd8f7_1781">Example Payload</p><div class="code-block" data-lang="none" > +</div><p id="5be93111_1754">To check your answers against the API. Send <code class="code" id="5be93111_1755">session</code> token and the <code class="code" id="5be93111_1756">id</code> of each selected element as a string comma separated as part of a data payload to <code class="code" id="5be93111_1757">/api/verify</code></p><p id="5be93111_1758">Example Payload</p><div class="code-block" data-lang="none" > session: "j4WjkoMcPgNX8_gnNXf8HA" answer: "UC0ZTVxCHkZanT5dnP2FZD4Q,UC4WvIIAo89_AzGUh1AZ6Dkg,UCe0JiGnjPfEwEIbWASbOimw" -</div><p id="64dbd8f7_1783">Response:</p><div class="code-block" data-lang="none" > +</div><p id="5be93111_1760">Response:</p><div class="code-block" data-lang="none" > { success: false } -</div><p id="64dbd8f7_1785">In the case above the user selected:</p><ul class="list _ul" id="64dbd8f7_1786"><li class="list__item" id="64dbd8f7_1787"><p>UC0ZTVxCHkZanT5dnP2FZD4Q</p></li><li class="list__item" id="64dbd8f7_1788"><p>UC4WvIIAo89_AzGUh1AZ6Dkg</p></li><li class="list__item" id="64dbd8f7_1789"><p>UCe0JiGnjPfEwEIbWASbOimw</p></li></ul><p id="64dbd8f7_1790">and their answer was incorrect.</p><p id="64dbd8f7_1791">After failing a captcha, the token becomes invalidated and a request for a new CAPTCHA must be made</p></section><section class="chapter"><h2 id="supported-keywords" data-toc="supported-keywords" >Supported Keywords</h2></section><section class="chapter"><h2 id="organization" data-toc="organization" >Organization</h2><ul class="list _ul" id="64dbd8f7_1792"><li class="list__item" id="64dbd8f7_1793"><p>Hololive: All hololive Production affiliated members, including Holostars</p></li><li class="list__item" id="64dbd8f7_1794"><p>Nijisanji: All Nijisanji affiliated livers, including EN branches (does not include VirtuaReal)</p></li></ul></section><div class="last-modified"> Last modified: 16 December 2023</div><div data-feedback-placeholder="true"></div><div class="navigation-links _bottom"> <a class="navigation-links__prev" href="patchwork-api.html">Patchwork Archive API</a> </div></article><div id="disqus_thread"></div></div></section></main></div> <script src="https://resources.jetbrains.com/writerside/apidoc/6.6.6-b205/app.js"></script></body></html>
\ No newline at end of file +</div><p id="5be93111_1762">In the case above the user selected:</p><ul class="list _ul" id="5be93111_1763"><li class="list__item" id="5be93111_1764"><p>UC0ZTVxCHkZanT5dnP2FZD4Q</p></li><li class="list__item" id="5be93111_1765"><p>UC4WvIIAo89_AzGUh1AZ6Dkg</p></li><li class="list__item" id="5be93111_1766"><p>UCe0JiGnjPfEwEIbWASbOimw</p></li></ul><p id="5be93111_1767">and their answer was incorrect.</p><p id="5be93111_1768">After failing a captcha, the token becomes invalidated and a request for a new CAPTCHA must be made</p></section><section class="chapter"><h2 id="supported-keywords" data-toc="supported-keywords" >Supported Keywords</h2></section><section class="chapter"><h2 id="organization" data-toc="organization" >Organization</h2><ul class="list _ul" id="5be93111_1769"><li class="list__item" id="5be93111_1770"><p>Hololive: All hololive Production affiliated members, including Holostars</p></li><li class="list__item" id="5be93111_1771"><p>Nijisanji: All Nijisanji affiliated livers, including EN branches (does not include VirtuaReal)</p></li></ul></section><div class="last-modified"> Last modified: 16 December 2023</div><div data-feedback-placeholder="true"></div><div class="navigation-links _bottom"> <a class="navigation-links__prev" href="patchwork-api.html">Patchwork Archive API</a> </div></article><div id="disqus_thread"></div></div></section></main></div> <script src="https://resources.jetbrains.com/writerside/apidoc/6.6.6-b205/app.js"></script></body></html>
\ No newline at end of file |