Skip to content

Latest commit

 

History

History
34 lines (21 loc) · 833 Bytes

README.md

File metadata and controls

34 lines (21 loc) · 833 Bytes

Sticky.io Client

An Elixir library for working with Sticky.

Installation

Install the dependency.

{:stickylixer, "~> 0.1.1"}

Configuration

To make API calls, it is necessary to configure your Sticky secret key.

use Mix.Config

config :stickylixer, :api_key, {"sticky-username", "sticky-password"}
config :stickylixer, :api_url, "http://localhost:5000/api/v1"

Examples

You can run Sticky.Credentials.validate_credentials/0 to ensure you are authenticated.

iex(1)> Sticky.Credentials.validate_credentials
{:ok, %{"response_code" => "100"}}

For a list of (most) available methods available, checkout the Sticky.io v1 docs. (NOTE: The Members endpoint is currently unsupported.)