britto / glass_factory_api

GlassFactoryApi

A client for GlassFactory Public API written in Elixir.

It is a working in progress so far.

Installation

To install GlassFactoryApi, add it to your mix.exs file:

defp deps do
  [
    {:glass_factory_api, "~> 0.1.0"}
  ]
end

Then, run $ mix deps.get.

Configuration

In order to consume the Glass Factory API you need the following:

• API URL
• User token
• User email
• Subdomain

These settings can be provided in three different ways.

Straight into the API calls (highest precedence):

GlassFactoryApi.Projects.get_project(id, %{
  api_url: "https://my-company.glassfactory.io",
  subdomain: "my-company",
  user_token: "JvBT4XBdoUE2swW3Gfm9",
  user_email: "[e-mail]"
})

Through your config files:

# config/config.exs

config :glass_factory_api, GlassFactoryApi.ApiClient,
  api_url: "https://my-company.glassfactory.io",
  subdomain: "my-company",
  user_token: "JvBT4XBdoUE2swW3Gfm9",
  user_email: "[e-mail]"

Or with environment variables (lowest precedence):

export GLASSFACTORY_API_URL="https://my-company.glassfactory.io"
export GLASSFACTORY_SUBDOMAIN="my-company"
export GLASSFACTORY_USER_TOKEN="JvBT4XBdoUE2swW3Gfm9"
export GLASSFACTORY_USER_EMAIL="[e-mail]"

GlassFactoryApi.Projects.get_project(id)

Contributing

WIP