ExShopify

Elixir client for accessing the Shopify admin REST web services.

ExShopify API documentation: https://hexdocs.pm/exshopify/api-reference.html

Installation

The package can be installed as:

1. Add exshopify to your list of dependencies in mix.exs:

```elixir
def deps do
  [{:exshopify, "~> 0.2.0"}]
end
```

1. Ensure exshopify is started before your application:

```elixir
def application do
  [applications: [:exshopify]]
end
```

Usage

Sessions

Sessions are responsible for telling ExShopify how to connect to Shopify's API. All requests made with ExShopify expect a session to be passed as the first argument.

Creating an ExShopify.Session is easy:

iex> ExShopify.Session.new

A session is just a simple struct that defines the following fields:

• access_token
• api_key
• domain
• port
• protocol
• secret
• shop_name
• shop_url

It's possible to define values for these fields either programmatically:

iex> ExShopify.Session.new(shop_name: "elixirshopify")
%ExShopify.Session{shop_name: "elixirshopify"}

or through the app configuration:

# config/config.exs

config :exshopify, shop_name: "elixirshopify"

...

iex> ExShopify.Session.new
%ExShopify.Session{shop_name: "elixirshopify"}

NOTE that arguments passed to new/1 will always override the app configuration.

Private Applications

To configure ExShopify for use with a private application all you will need to do is provide a shop_url to the session.

config :exshopify, shop_url: "https://#{api_key}:#{password}@#{shop_name}.myshopify.com/admin")

...

{:ok, order, meta} = ExShopify.Order.find(ExShopify.Session.new, 450789469)

Partner Applications

Partner applications need to go through the Shopify OAuth flow in order to obtain an access token that will grant access to a shop's API.

Please see steps 1 and 2 as part of the Shopify OAuth documentation.

To complete Step 3: Confirming installation you will need to trade an authorization code for an access token.

{:ok, access_token, meta} = ExShopify.AccessToken.create(session, authorization_code)

Please note that session must have values for both api_key and secret.

Additional Resources

API documentation: http://docs.shopify.com/api

Ask questions on the forums: http://ecommerce.shopify.com/c/shopify-apis-and-technology