{"id":"ae1218fa-f0ce-4346-b356-fa965fd51db9","createdDate":"2024-09-16T13:58:18.063Z","updatedDate":"2024-09-16T13:58:18.063Z","resourceId":"e4f1909c-5167-4833-87fe-9bc330ae0d1a","sdk":{"schema":{"name":"captcha_captcha","fqn":"","slug":"captcha-captcha","typesMap":{"CaptchaResponse":{"name":"CaptchaResponse","fqn":"CaptchaResponse","slug":"captcha-response","actions":[],"properties":[{"name":"errors","slug":"errors","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Errors","referenceFqn":"Errors"},"description":"Error information."},{"name":"success","slug":"success","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Value is `true` when authorization is successful."}]},"Errors":{"name":"Errors","fqn":"Errors","slug":"errors","actions":[],"properties":[{"name":"errorId","slug":"error-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"ID of error."}]}},"standaloneTypes":[],"metadata":{"fqdn":"wix.captcharator.v1.captcha_entity"},"actions":[{"name":"authorize","fqn":"authorize","slug":"authorize","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","requiredProperties":["token"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"CaptchaResponse","referenceFqn":"CaptchaResponse"}},"examples":[{"title":"authorize: Wix-hosted","content":"import { captcha } from '@wix/captcha';\n\nasync function authorize(token, options) {\n const response = await captcha.authorize(token, options);\n};"},{"title":"authorize: Self-hosted","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { captcha } from '@wix/captcha';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { captcha },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function authorize(token, options) {\n const response = await myWixClient.captcha.authorize(token, options);\n};"}],"actionParams":[{"name":"token","slug":"token","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The CAPTCHA token to authorize."}],"description":"Authorizes the CAPTCHA token.\n\n\nFollowing CAPTCHA verification on the client side, you must authorize the generated CAPTCHA token in the backend.\n\n`authorize()` checks if the token is valid, making sure it was not tampered with or timed out.\n\nThe `authorize()` function returns a Promise that resolves to a `Success` object when the token is authorized and to an `Error` object when authorization fails.\n\nTo understand how `authorize()` is used in a typical CAPTCHA validation lifecycle, click [here](/$w/captcha/introduction).\n\nIf CAPTCHA token authorization fails, an error message containing a status code is returned. The following table lists the possible HTTP error status codes, based on [RFC 2616](https://tools.ietf.org/html/rfc2616#section-10):\n\n| Status Code | Name | Description |\n|---|---|---|\n| 400 | Bad Request | The request could not be understood by the server. This could occur for a number of reasons, such as:

The request was sent without a token.
The token is invalid.
The token has timed out.

|\n| 401 | Unauthenticated | No user identity found in passed request. |\n| 500 | Internal Server Error | The server encountered an unexpected condition, such as a missing or invalid private CAPTCHA key. |\n| 503 | Unavailable | The service is unavailable due to one of the following:

Throttled error: Server overload due to more than the allowed requests in a given time frame.
Request failed: No response following 10 retries with a 1-second interval.

|"}],"webhooks":[],"articles":[{"content":"To use the Captcha API, install the `@wix/captcha` package using npm or Yarn:\n ```console\nnpm install @wix/captcha\n```\n\nor\n\n```console\nyarn add @wix/captcha\n```\n\nThen import `{ captcha }` from `@wix/captcha`:\n\n```js\nimport { captcha } from '@wix/captcha'\n```\n ","displayName":"Setup","slugifyName":"setup"}],"builderTypes":[],"properties":[],"namespaces":[]}},"reviewStatus":"UNKNOWN","isLocked":false,"metadata":{"packageVersion":"1.0.0"}}