Verify a Captcha

Server endpoints can be used as REST API endpoints to run functions such as authentications, database access, and verifications without exposing sensitive data to the client.

In this recipe, an API route is used to verify Google reCAPTCHA v3 without exposing the secret to clients.

Prerequisites

Section titled Prerequisites
  • A project with SSR (output: 'server') enabled

Recipe

Section titled Recipe

  1. Create a post endpoint that accepts recaptcha data, then verifies it with reCAPTCHA’s API. Here, you can safely define secret values or read environment variables.

    src/pages/recaptcha.js
    export async function post({ request }) {
      const data = await request.json();
    

      const recaptchaURL = 'https://www.google.com/recaptcha/api/siteverify';
      const requestBody = {
        secret: "YOUR_SITE_SECRET_KEY",   // This can be an environment variable
        response: data.recaptcha          // The token passed in from the client
      };
    

      const response = await fetch(recaptchaURL, {
        method: "POST",
        body: JSON.stringify(requestBody)
      });
    

      const responseData = await response.json();
    

      return new Response(JSON.stringify(responseData), { status: 200 });
    }

  2. Access your endpoint using fetch from a client script:

    src/pages/index.astro
    <html>
      <head>
        <script src="https://www.google.com/recaptcha/api.js"></script>
      </head>
    

      <body>
        <button class="g-recaptcha"
          data-sitekey="PUBLIC_SITE_KEY"
          data-callback="onSubmit"
          data-action="submit"> Click me to verify the captcha challenge! </button>
    

        <script is:inline>
          function onSubmit(token) {
            fetch("/recaptcha", {
              method: "POST",
              body: JSON.stringify({ recaptcha: token })
            })
            .then((response) => response.json())
            .then((gResponse) => {
              if (gResponse.success) {
                // Captcha verification was a success
              } else {
                // Captcha verification failed
              }
            })
          }
        </script>
      </body>
    </html>

More recipes