Signaturex v1.4.0

Signaturex (Signaturex v1.4.0) View Source

Link to this section Summary

Functions

sign(key, secret, method, path, params)

Sign a request using key, secret, HTTP method, query string params and an optional body

validate(key, secret, method, path, params, timestamp_grace \\ 600)

Validate request

validate!(key, secret, method, path, params, timestamp_grace \\ 600)

Validate request

Link to this section Functions

Link to this function

sign(key, secret, method, path, params)

View Source

Specs

sign(binary(), binary(), binary() | atom(), binary(), map()) :: map()

Sign a request using key, secret, HTTP method, query string params and an optional body

Link to this function

validate(key, secret, method, path, params, timestamp_grace \\ 600)

View Source

Specs

validate(binary(), binary(), binary() | atom(), binary(), map(), integer()) ::
  boolean()

Validate request

Returns true or false

Link to this function

validate!(key, secret, method, path, params, timestamp_grace \\ 600)

View Source

Specs

validate!(binary(), binary(), binary() | atom(), binary(), map(), integer()) ::
  true

Validate request

Raises an AuthenticationError if the request is invalid