shopify v0.1.3 Shopify.OAuth

Summary

Functions

Builds a new permission url for a shop

Requests a new access token for a shop

Functions

permission_url(session, params \\ %{})

Builds a new permission url for a shop.

Returns “https://shop-name.myshopify.com/admin/oauth/authorize?”

Parameters

  • session: A %Shopify.Session{} struct.
  • params: A map of additional query params.

Examples

iex> Shopify.session("shop-name") |> Shopify.OAuth.permission_url(%{scope: "read_orders", redirect_uri: "http://my-url.com/"})
"https://shop-name.myshopify.com/admin/oauth/authorize?client_id=CLIENTID&redirect_uri=http%3A%2F%2Fmy-url.com%2F&scope=read_orders"
request_token(session, code)

Requests a new access token for a shop.

Returns {:ok, %Shopify.Oauth{}} or {:error, %Shopify.Error{}}

Parameters

  • session: A %Shopify.Session{} struct.
  • code: The code returned to your redirect_uri after permission has been granted.

Examples

iex> Shopify.session("shop-name") |> Shopify.OAuth.request_token("code")
%Shopify.OAuth{access_token: "access-token", associated_user: nil, associated_user_scope: nil, expires_in: nil, scope: "read_orders"}}