Go API client for recaptcha

reCAPTCHA v3 returns a score for each request without user friction. The score is based on interactions with your site and enables you to take an appropriate action for your site. Register reCAPTCHA v3 keys on the reCAPTCHA Admin console.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

API version: 3.0.0
Package version: 1.0.0
Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit mailto:[email protected]?subject=reCAPTCHA%20Go

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import recaptcha "github.com/pourcheragh/recaptcha-go"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Simple Usage

package main

import (
	"context"
	"errors"
	"fmt"

	"github.com/pourcheragh/recaptcha-go"
)

func main() {
	ctx := context.Background()
	client := recaptcha.NewAPIClient(recaptcha.NewConfiguration())

	if ok, err := verify(ctx, client, "shared-secret-key", "user-response"); err != nil {
		fmt.Println("unsuccessful reCAPTCHA call: %w", err)
	} else if !ok {
		fmt.Println("invalid reCAPTCHA response")
	} else {
		fmt.Println("reCAPTCHA verified successfully")
	}
}

func verify(ctx context.Context, client *recaptcha.APIClient, secret, response string) (bool, error) {
	req := client.VerifyAPI.SiteVerify(ctx)
	req = req.Secret(secret)
	req = req.Response(response)

	v, _, err := req.Execute()
	if err != nil {
		return false, err
	}
	if v.ErrorCodes != nil && len(v.ErrorCodes) > 0 {
		return v.Success, errors.New(string(v.ErrorCodes[0]))
	}
	return v.Success, nil
}

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value recaptcha.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), recaptcha.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value recaptcha.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), recaptcha.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using recaptcha.ContextOperationServerIndices and recaptcha.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), recaptcha.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), recaptcha.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://www.google.com/recaptcha/api

Class	Method	HTTP request	Description
VerifyAPI	SiteVerify	Post /siteverify	Verify User Response

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

PtrBool
PtrInt
PtrInt32
PtrInt64
PtrFloat
PtrFloat32
PtrFloat64
PtrString
PtrTime

Author

[email protected]

# Packages

# README