The highest tagged major version is v7.

sdk

package

v2.0.0 Latest Latest Go to latest Published: Jan 23, 2023 License: MIT Imports: 19 Imported by: 0

Documentation ¶

Overview ¶

* Fingerprint Pro Server API * * Fingerprint Pro Server API allows you to get information about visitors and about individual events in a server environment. This API can be used for data exports, decision-making, and data analysis scenarios. * * API version: 3 * Contact: support@fingerprint.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Fingerprint Pro Server API * * Fingerprint Pro Server API provides a way for validating visitors’ data issued by Fingerprint Pro. * * API version: 3 * Contact: support@fingerprint.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Fingerprint Pro Server API * * Fingerprint Pro Server API allows you to get information about visitors and about individual events in a server environment. This API can be used for data exports, decision-making, and data analysis scenarios. * * API version: 3 * Contact: support@fingerprint.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Fingerprint Pro Server API * * Fingerprint Pro Server API provides a way for validating visitors’ data issued by Fingerprint Pro. * * API version: 3 * Contact: support@fingerprint.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Fingerprint Pro Server API * * Fingerprint Pro Server API allows you to get information about visitors and about individual events in a server environment. This API can be used for data exports, decision-making, and data analysis scenarios. * * API version: 3 * Contact: support@fingerprint.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

Index ¶

Variables
func ParseResponse(httpResponse *http.Response, error interface{})
type APIClient
- func NewAPIClient(cfg *Configuration) *APIClient
type APIKey
type APIResponse
- func NewAPIResponse(r *http.Response) *APIResponse
- func NewAPIResponseWithError(errorMessage string) *APIResponse
type BasicAuth
type BotdDetectionResult
type BotdError
type BotdResult
type BrowserDetails
type Confidence
type Configuration
- func NewConfiguration() *Configuration
- func (c *Configuration) AddDefaultHeader(key string, value string)
- func (c *Configuration) ChangeBasePath(path string)
- func (c *Configuration) ChangeRegion(region Region)
- func (c *Configuration) GetBasePath() string
- func (c *Configuration) GetRegion() Region
type ErrorEvent403Response
type ErrorEvent403ResponseError
type ErrorEvent404Response
type ErrorEvent404ResponseError
type ErrorResponse
type ErrorResponseError
type ErrorVisits403
type EventResponse
type FingerprintApiGetVisitsOpts
type FingerprintApiService
- func (a *FingerprintApiService) GetEvent(ctx context.Context, requestId string) (EventResponse, *http.Response, error)
- func (a *FingerprintApiService) GetVisits(ctx context.Context, visitorId string, ...) (Response, *http.Response, error)
type GenericSwaggerError
- func (e GenericSwaggerError) Body() []byte
- func (e GenericSwaggerError) Error() string
- func (e GenericSwaggerError) Model() interface{}
type IdentificationError
type IpLocation
type IpLocationCity
type Location
type ManyRequestsResponse
type Model
type ModelMap
type ProductsResponse
type ProductsResponseBotd
type ProductsResponseIdentification
type ProductsResponseIdentificationData
type Region
type Response
type ResponseVisits
type SeenAt
type StSeenAt
type Subdivision
type Visit
type WebhookVisit

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions ¶

func ParseResponse ¶

func ParseResponse(httpResponse *http.Response, error interface{})

Types ¶

type APIClient ¶

type APIClient struct {
	FingerprintApi *FingerprintApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Fingerprint Pro Server API API v3 In most cases there should be only one, shared, APIClient.

func NewAPIClient ¶

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

type APIKey ¶

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse ¶

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the swagger operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

func NewAPIResponse ¶

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError ¶

func NewAPIResponseWithError(errorMessage string) *APIResponse

type BasicAuth ¶

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type BotdDetectionResult ¶

type BotdDetectionResult struct {
	// Bot detection result:  * `notDetected` - the visitor is not a bot  * `good` - good bot detected, such as Google bot, Baidu Spider, AlexaBot and so on  * `bad` - bad bot detected, such as Selenium, Puppeteer, Playwright, headless browsers, and so on
	Result string `json:"result"`
}

Stores bot detection result

type BotdError ¶

type BotdError struct {
	// Error code:  * `TooManyRequests` - the limit on secret API key requests per second has been exceeded  * `Failed` - internal server error
	Code    string `json:"code"`
	Message string `json:"message"`
}

type BotdResult ¶

type BotdResult struct {
	// IP address of the requesting browser or bot.
	Ip string `json:"ip"`
	// Time in UTC when the request from the JS agent was made. We recommend to treat requests that are older than 2 minutes as malicious. Otherwise, request replay attacks are possible
	Time *time.Time `json:"time"`
	// Page URL from which identification request was sent.
	Url string               `json:"url"`
	Bot *BotdDetectionResult `json:"bot"`
}

Contains all the information from Bot Detection product

type BrowserDetails ¶

type BrowserDetails struct {
	BrowserName         string `json:"browserName"`
	BrowserMajorVersion string `json:"browserMajorVersion"`
	BrowserFullVersion  string `json:"browserFullVersion"`
	Os                  string `json:"os"`
	OsVersion           string `json:"osVersion"`
	Device              string `json:"device"`
	UserAgent           string `json:"userAgent"`
	BotProbability      int32  `json:"botProbability,omitempty"`
}

type Confidence ¶

type Confidence struct {
	// The confidence score is a floating-point number between 0 and 1 that represents the probability of accurate identification.
	Score float32 `json:"score"`
}

type Configuration ¶

type Configuration struct {
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
	// contains filtered or unexported fields
}

func NewConfiguration ¶

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader ¶

func (c *Configuration) AddDefaultHeader(key string, value string)

func (*Configuration) ChangeBasePath ¶

func (c *Configuration) ChangeBasePath(path string)

ChangeBasePath Change base path to allow switching to mocks

func (*Configuration) ChangeRegion ¶

func (c *Configuration) ChangeRegion(region Region)

ChangeRegion Changes region and sets basePath for it

func (*Configuration) GetBasePath ¶

func (c *Configuration) GetBasePath() string

func (*Configuration) GetRegion ¶

func (c *Configuration) GetRegion() Region

type ErrorEvent403Response ¶

type ErrorEvent403Response struct {
	Error_ *ErrorEvent403ResponseError `json:"error,omitempty"`
}

type ErrorEvent403ResponseError ¶

type ErrorEvent403ResponseError struct {
	// Error code:  * `TokenRequired` - `Auth-API-Key` header is missing or empty  * `TokenNotFound` - subscription not found for specified secret key  * `SubscriptionNotActive` - subscription is not active  * `WrongRegion` - server and subscription region differ
	Code    string `json:"code"`
	Message string `json:"message"`
}

type ErrorEvent404Response ¶

type ErrorEvent404Response struct {
	Error_ *ErrorEvent404ResponseError `json:"error,omitempty"`
}

type ErrorEvent404ResponseError ¶

type ErrorEvent404ResponseError struct {
	// Error code:  * `RequestNotFound` - request not found for specified id
	Code    string `json:"code"`
	Message string `json:"message"`
}

type ErrorResponse ¶

type ErrorResponse struct {
	Error_ *ErrorResponseError `json:"error,omitempty"`
}

type ErrorResponseError ¶

type ErrorResponseError struct {
	Code    string `json:"code,omitempty"`
	Message string `json:"message,omitempty"`
}

type ErrorVisits403 ¶

type ErrorVisits403 struct {
	// Error text.
	Error_ string `json:"error"`
}

type EventResponse ¶

type EventResponse struct {
	Products *ProductsResponse `json:"products,omitempty"`
}

Contains event from activated products - Fingerprint Pro or Bot Detection

type FingerprintApiGetVisitsOpts ¶

type FingerprintApiGetVisitsOpts struct {
	RequestId optional.String
	LinkedId  optional.String
	Limit     optional.Int32
	Before    optional.Int32
}

type FingerprintApiService ¶

type FingerprintApiService service

func (*FingerprintApiService) GetEvent ¶

func (a *FingerprintApiService) GetEvent(ctx context.Context, requestId string) (EventResponse, *http.Response, error)

FingerprintApiService Get event by requestId This endpoint allows you to get events with all the information from each activated product (Fingerprint Pro or Bot Detection). Use the requestId as a URL path :request_id parameter. This API method is scoped to a request, i.e. all returned information is by requestId.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param requestId requestId is the unique identifier of each request

@return EventResponse

func (*FingerprintApiService) GetVisits ¶

func (a *FingerprintApiService) GetVisits(ctx context.Context, visitorId string, localVarOptionals *FingerprintApiGetVisitsOpts) (Response, *http.Response, error)

type GenericSwaggerError ¶

type GenericSwaggerError struct {
	// contains filtered or unexported fields
}

GenericSwaggerError Provides access to the body, error and model on returned errors.

func (GenericSwaggerError) Body ¶

func (e GenericSwaggerError) Body() []byte

Body returns the raw bytes of the response

func (GenericSwaggerError) Error ¶

func (e GenericSwaggerError) Error() string

Error returns non-empty string if there was an error.

func (GenericSwaggerError) Model ¶

func (e GenericSwaggerError) Model() interface{}

Model returns the unpacked model of the error

type IdentificationError ¶

type IdentificationError struct {
	// Error code:  * `429 Too Many Requests` - the limit on secret API key requests per second has been exceeded  * `Failed` - internal server error
	Code    string `json:"code"`
	Message string `json:"message"`
}

type IpLocation ¶

type IpLocation struct {
	AccuracyRadius int32           `json:"accuracyRadius"`
	Latitude       float64         `json:"latitude"`
	Longitude      float64         `json:"longitude"`
	PostalCode     string          `json:"postalCode,omitempty"`
	Timezone       string          `json:"timezone"`
	City           *IpLocationCity `json:"city,omitempty"`
	Country        *Location       `json:"country"`
	Continent      *Location       `json:"continent"`
	Subdivisions   []Subdivision   `json:"subdivisions,omitempty"`
}

type IpLocationCity ¶

type IpLocationCity struct {
	Name string `json:"name,omitempty"`
}

type Location ¶

type Location struct {
	Code string `json:"code"`
	Name string `json:"name"`
}

type ManyRequestsResponse ¶

type ManyRequestsResponse struct {
	// Error text.
	Error_     string `json:"error"`
	RetryAfter int64
}

type Model ¶

type Model struct{}

type ModelMap ¶

type ModelMap map[string]string

type ProductsResponse ¶

type ProductsResponse struct {
	Identification *ProductsResponseIdentification `json:"identification,omitempty"`
	Botd           *ProductsResponseBotd           `json:"botd,omitempty"`
}

Contains all the information from each activated product - Fingerprint Pro or Bot Detection

type ProductsResponseBotd ¶

type ProductsResponseBotd struct {
	Data   *BotdResult `json:"data,omitempty"`
	Error_ *BotdError  `json:"error,omitempty"`
}

type ProductsResponseIdentification ¶

type ProductsResponseIdentification struct {
	Data   *ProductsResponseIdentificationData `json:"data,omitempty"`
	Error_ *IdentificationError                `json:"error,omitempty"`
}

type ProductsResponseIdentificationData ¶

type ProductsResponseIdentificationData struct {
	// Unique identifier of the user's identification request.
	RequestId      string          `json:"requestId"`
	BrowserDetails *BrowserDetails `json:"browserDetails"`
	// Flag if user used incognito session.
	Incognito  bool        `json:"incognito"`
	Ip         string      `json:"ip"`
	IpLocation *IpLocation `json:"ipLocation"`
	// Timestamp of the event with millisecond precision in Unix time.
	Timestamp int64 `json:"timestamp"`
	// Time expressed according to ISO 8601 in UTC format.
	Time *time.Time `json:"time"`
	// Page URL from which identification request was sent.
	Url string `json:"url"`
	// A customer-provided value or an object that was sent with identification request.
	Tag ModelMap `json:"tag,omitempty"`
	// A customer-provided id that was sent with identification request.
	LinkedId   string      `json:"linkedId,omitempty"`
	Confidence *Confidence `json:"confidence"`
	// Attribute represents if a visitor had been identified before.
	VisitorFound bool    `json:"visitorFound"`
	FirstSeenAt  *SeenAt `json:"firstSeenAt"`
	LastSeenAt   *SeenAt `json:"lastSeenAt"`
	VisitorId    string  `json:"visitorId"`
}

type Region ¶

type Region string

const (
	RegionEU   Region = "eu"
	RegionUS   Region = "us"
	RegionAsia Region = "asia"
)

type Response ¶

type Response struct {
	VisitorId string           `json:"visitorId"`
	Visits    []ResponseVisits `json:"visits"`
	// When more results are available (e.g., you scanned 200 results using `limit` parameter, but a total of 600 results are available), a special `lastTimestamp` top-level attribute is added to the response. If you want to paginate the results further in the past, you should use the value of this attribute.
	LastTimestamp int64 `json:"lastTimestamp,omitempty"`
	// Visit's `requestId` of the last visit in the current page.
	PaginationKey string `json:"paginationKey,omitempty"`
}

Fields `lastTimestamp` and `paginationKey` added when `limit` or `before` parameter provided and there is more data to show

type ResponseVisits ¶

type ResponseVisits struct {
	// Unique identifier of the user's identification request.
	RequestId      string          `json:"requestId"`
	BrowserDetails *BrowserDetails `json:"browserDetails"`
	// Flag if user used incognito session.
	Incognito  bool        `json:"incognito"`
	Ip         string      `json:"ip"`
	IpLocation *IpLocation `json:"ipLocation"`
	// Timestamp of the event with millisecond precision in Unix time.
	Timestamp int64 `json:"timestamp"`
	// Time expressed according to ISO 8601 in UTC format.
	Time *time.Time `json:"time"`
	// Page URL from which identification request was sent.
	Url string `json:"url"`
	// A customer-provided value or an object that was sent with identification request.
	Tag ModelMap `json:"tag"`
	// A customer-provided id that was sent with identification request.
	LinkedId   string      `json:"linkedId,omitempty"`
	Confidence *Confidence `json:"confidence"`
	// Attribute represents if a visitor had been identified before.
	VisitorFound bool    `json:"visitorFound"`
	FirstSeenAt  *SeenAt `json:"firstSeenAt"`
	LastSeenAt   *SeenAt `json:"lastSeenAt"`
}

type SeenAt ¶

type SeenAt struct {
	Global       *time.Time `json:"global"`
	Subscription *time.Time `json:"subscription"`
}

type StSeenAt ¶

type StSeenAt struct {
	Global       *time.Time `json:"global"`
	Subscription *time.Time `json:"subscription"`
}

type Subdivision ¶

type Subdivision struct {
	IsoCode string `json:"isoCode,omitempty"`
	Name    string `json:"name,omitempty"`
}

type Visit ¶

type Visit struct {
	// Unique identifier of the user's identification request.
	RequestId      string          `json:"requestId"`
	BrowserDetails *BrowserDetails `json:"browserDetails"`
	// Flag if user used incognito session.
	Incognito  bool        `json:"incognito"`
	Ip         string      `json:"ip"`
	IpLocation *IpLocation `json:"ipLocation"`
	// Timestamp of the event with millisecond precision in Unix time.
	Timestamp int64 `json:"timestamp"`
	// Time expressed according to ISO 8601 in UTC format.
	Time *time.Time `json:"time"`
	// Page URL from which identification request was sent.
	Url string `json:"url"`
	// A customer-provided value or an object that was sent with identification request.
	Tag ModelMap `json:"tag,omitempty"`
	// A customer-provided id that was sent with identification request.
	LinkedId   string      `json:"linkedId,omitempty"`
	Confidence *Confidence `json:"confidence"`
	// Attribute represents if a visitor had been identified before.
	VisitorFound bool    `json:"visitorFound"`
	FirstSeenAt  *SeenAt `json:"firstSeenAt"`
	LastSeenAt   *SeenAt `json:"lastSeenAt"`
}

type WebhookVisit ¶

type WebhookVisit struct {
	VisitorId      string `json:"visitorId"`
	ClientReferrer string `json:"clientReferrer,omitempty"`
	// Unique identifier of the user's identification request.
	RequestId      string          `json:"requestId"`
	BrowserDetails *BrowserDetails `json:"browserDetails"`
	// Flag if user used incognito session.
	Incognito  bool        `json:"incognito"`
	Ip         string      `json:"ip"`
	IpLocation *IpLocation `json:"ipLocation"`
	// Timestamp of the event with millisecond precision in Unix time.
	Timestamp int64 `json:"timestamp"`
	// Time expressed according to ISO 8601 in UTC format.
	Time *time.Time `json:"time"`
	// Page URL from which identification request was sent.
	Url string `json:"url"`
	// A customer-provided value or an object that was sent with identification request.
	Tag ModelMap `json:"tag,omitempty"`
	// A customer-provided id that was sent with identification request.
	LinkedId   string      `json:"linkedId,omitempty"`
	Confidence *Confidence `json:"confidence"`
	// Attribute represents if a visitor had been identified before.
	VisitorFound bool    `json:"visitorFound"`
	FirstSeenAt  *SeenAt `json:"firstSeenAt"`
	LastSeenAt   *SeenAt `json:"lastSeenAt"`
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL