Arkvatar-ex

API Wrapper to interact with Arkvatar.

Built with

Installation

If available in Hex, the package can be installed by adding arkvatar to your list of dependencies in mix.exs:

def deps do
  [
    {:arkvatar, "~> 1.0.0"}
  ]
end

Now you can run the mix deps.get command from your shell.

Documentation can be generated with ExDoc and published on HexDocs. Once published, the docs can be found at https://hexdocs.pm/elixir_arkvatar.

Usage

Fetching an arkvatar

$ iex -S mix

iex(1)> Arkvatar.Api.show("test@gmail.com")
{:ok, ... }

Verifying an identifier

$ iex -S mix

iex(1)> Arkvatar.Api.verify("test@gmail.com")
{:ok, ... }

Creating a new Arkvatar

$ iex -S mix

# Without specifying the type
iex(1)> Arkvatar.Api.store(%{identifier: "test@gmail.com")}
{:ok, ... }

# With a type
iex(2)> Arkvatar.Api.store(%{type: "Email", identifier: "test@gmail.com")}
{:ok, ... }

# With full parameters 
iex(3)> Arkvatar.Api.store(%{type: "Email", identifier: "test@gmail.com", qr_code: true, vertical_gradient: true, no_background: false})

Authors

License

Arkvatar-ex is under MIT license. See the LICENSE file for more informations.