Signaturex v1.0.0 → Overview → Signaturex

Signaturex

Source

Summary

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

Functions

sign(key, secret, method, path, params)
(function) # ↑

Specs:

  • sign(binary, binary, binary | atom, binary, Dict.t) :: Dict.t

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

Source
validate(key, secret, method, path, params, timestamp_grace \\ 600)
(function) # ↑

Specs:

  • validate(binary, binary, binary | atom, binary, Dict.t, integer) :: boolean

Validate request

Returns true or false

Source
validate!(key, secret, method, path, params, timestamp_grace \\ 600)
(function) # ↑

Specs:

  • validate!(binary, binary, binary | atom, binary, Dict.t, integer) :: true

Validate request

Raises an AuthenticationError if the request is invalid

Source