From 5a58f0192a1992f0a1a31f9981f480cec67f0faa Mon Sep 17 00:00:00 2001 From: Pinapelz Date: Sat, 16 Dec 2023 15:57:40 -0800 Subject: fix: build --- vtuber-captcha.html | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'vtuber-captcha.html') diff --git a/vtuber-captcha.html b/vtuber-captcha.html index 0357f12..1709849 100644 --- a/vtuber-captcha.html +++ b/vtuber-captcha.html @@ -1,4 +1,4 @@ - VTuber Captcha | Project Knowledge Base

Project Knowledge Base Help

VTuber Captcha

A simple web API that serves VTuber related CAPTCHAs including server-side verification. Bring your own frontend to display the data.

Available Endpoints

The base URL or the API currently is: https://vtuber-captcha.vercel.app/api

Below are the current API endpoints supported: Authenticating Against the API

/affiliation/<org>

Returns a captcha asking user to identify which of the VTubers are affiliated with a particular organization or group

Path Parameters

  • <org>: Refer to organization page for a list of supported terms Query Parameters

  • server_auth: 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.

    • Default: false

    • Enums: true, false

Authenticating Answers Against The Server

The API supports server-side verification meaning that the answer to the CAPTCHA is never sent to you after making the initial request.

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.

To authenticate answers against the API. You need to specify the query parameter ?server_auth=true

Example Response with ?server_auth=true

+ VTuber Captcha | Project Knowledge Base

Project Knowledge Base Help

VTuber Captcha

A simple web API that serves VTuber related CAPTCHAs including server-side verification. Bring your own frontend to display the data.

Available Endpoints

The base URL or the API currently is: https://vtuber-captcha.vercel.app/api

Below are the current API endpoints supported: Authenticating Against the API

/affiliation/<org>

Returns a captcha asking user to identify which of the VTubers are affiliated with a particular organization or group

Path Parameters

  • <org>: Refer to organization page for a list of supported terms Query Parameters

  • server_auth: 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.

    • Default: false

    • Enums: true, false

Authenticating Answers Against The Server

The API supports server-side verification meaning that the answer to the CAPTCHA is never sent to you after making the initial request.

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.

To authenticate answers against the API. You need to specify the query parameter ?server_auth=true

Example Response with ?server_auth=true

{ "category": "affiliation", "onFail": { @@ -90,11 +90,11 @@ "session": "GUQkquh03dwF84EAxif_EA", "title": "Select all the VTuber affiliated with Hololive" } -

To check your answers against the API. Send session token and the id of each selected element as a string comma separated as part of a data payload to /api/verify

Example Payload

+

To check your answers against the API. Send session token and the id of each selected element as a string comma separated as part of a data payload to /api/verify

Example Payload

session: "j4WjkoMcPgNX8_gnNXf8HA" answer: "UC0ZTVxCHkZanT5dnP2FZD4Q,UC4WvIIAo89_AzGUh1AZ6Dkg,UCe0JiGnjPfEwEIbWASbOimw" -

Response:

+

Response:

{ success: false } -

In the case above the user selected:

  • UC0ZTVxCHkZanT5dnP2FZD4Q

  • UC4WvIIAo89_AzGUh1AZ6Dkg

  • UCe0JiGnjPfEwEIbWASbOimw

and their answer was incorrect.

After failing a captcha, the token becomes invalidated and a request for a new CAPTCHA must be made

Supported Keywords

Organization

  • Hololive: All hololive Production affiliated members, including Holostars

  • Nijisanji: All Nijisanji affiliated livers, including EN branches (does not include VirtuaReal)

Last modified: 16 December 2023
Patchwork Archive API
\ No newline at end of file +

In the case above the user selected:

  • UC0ZTVxCHkZanT5dnP2FZD4Q

  • UC4WvIIAo89_AzGUh1AZ6Dkg

  • UCe0JiGnjPfEwEIbWASbOimw

and their answer was incorrect.

After failing a captcha, the token becomes invalidated and a request for a new CAPTCHA must be made

Supported Keywords

Organization

  • Hololive: All hololive Production affiliated members, including Holostars

  • Nijisanji: All Nijisanji affiliated livers, including EN branches (does not include VirtuaReal)

Last modified: 16 December 2023
Patchwork Archive API IMissSomeone-VT
\ No newline at end of file -- cgit v1.2.3