api

Documentation

Index

• Variables
• type App
  • func (a *App) CheckGeoLocation(c *gin.Context)
  • func (a *App) Initialize(testing bool)
  • func (a *App) Run(address string)
• type Outbound

Variables

var Ip_Country_Mapping = make(map[netaddr.IP]string)

Types

type App

type App struct {
	Router   *gin.Engine
	Outbound *Outbound
}

App structured as standalone object to better facilitate testing

func (*App) CheckGeoLocation

func (a *App) CheckGeoLocation(c *gin.Context)

CheckGeoLocation is our main endpoint We expect a POST from an outside endpoint with basic auth header and a json payload format:

{
    "ip_address": "X.X.X.X",
    "country_names": [
	"Mexico",
	"Canada",

] } This endpoint will return a 302 if the IP was mapped to a country in the country_names list or a 404 if the IP lookup fails Other error codes are 400 if the json payload is malformed or the IP does not conform to IPv4 or IPv6 standards

func (*App) Initialize

func (a *App) Initialize(testing bool)

func (*App) Run

func (a *App) Run(address string)

type Outbound

type Outbound struct {
	UserId     string
	LicenseKey string
	Client     *http.Client
}