The link to WeChat Official Account Platform API document in Chinese | English.

Currently, there are two ways to use the WeChat's APIs:

• As common application, directly integrates WeChat's APIs after trun on your WeChat Official Account into the developer mode (see details);
• As component application, authorizes your WeChat Official Account to the WeChat Official Account third-party platform application, leverages a set of common solutions from the third-party platform (see details).

Refer the official document's recommend to manage access token (see details), we need to temporarily storage access token in a centralization way, we prepare four behaviours to manage the minimum responsibilities for each use case.

Use this library in the 3rd-party webapp which can read the temporary storage data (e.g. access token/jsapi-ticket/card-ticket) from the centralization nodes(hereinafter "hub"):

• The WeChat.Storage.Client storage adapter behaviour is required for the common application;
• The WeChat.Storage.ComponentClient storage adapter behaviour is required for the component application.

Use this library in the hub webapp:

• The WeChat.Storage.Hub storage adapter behaviour is required for the common application;
• The WeChat.Storage.ComponentHub storage adapter behaviour is required for the component application.

As usual, the hub webapp is one-off setup to use this library, most of time we use elixir_wechat is in the 3rd-party webapp as a client, so here provide a default storage adapter to conveniently initialize it as a client use case:

• The WeChat.Storage.Adapter.DefaultClient implements WeChat.Storage.Client behaviour, and is used for the common application by default:

  defmodule MyClient do
    use WeChat,
      adapter_storage: {:default, "http://localhost:4000"}
  end
  # the above equals the following
  #
  defmodule MyClient do
    use WeChat,
      adapter_storage: {WeChat.Storage.Adapter.DefaultClient, "http://localhost:4000"}
  end

• The WeChat.Storage.Adapter.DefaultComponentClient implements WeChat.Storage.ComponentClient behaviour, and is used for the component application by default:

  defmodule MyComponentClient do
    use WeChat.Component,
      adapter_storage: {:default, "http://localhost:4000"}
  end
  # the above equals the following
  #
  defmodule MyComponentClient do
    use WeChat.Component,
      adapter_storage: {WeChat.Storage.Adapter.DefaultComponentClient, "http://localhost:4000"}
  end

Usage

As common application

defmodule MyClient do
  use WeChat,
    adapter_storage: {:default, "http://localhost:4000"},
    appid: "MyAppID"
end

MyClient.request(:post, url: "WeChatURL1", body: %{}, query: [])
MyClient.request(:get, url: "WeChatURL2", query: [])

Or use WeChat.request/2 directly

WeChat.request(:post, url: "WeChatURL1",
  appid: "MyAppID", adapter_storage: {:default, "http://localhost:4000"},
  body: %{}, query: [])

WeChat.request(:get, url: "WeChatURL2",
  appid: "MyAppID", adapter_storage: {:default, "http://localhost:4000"},
  query: [])

As component application

defmodule MyComponentClient do
  use WeChat.Component,
    adapter_storage: {:default, "http://localhost:4000"},
    appid: "MyAppID",
    authorizer_appid: "MyAuthorizerAppID"
end

MyComponentClient.request(:post, url: "WeChatURL1", body: %{}, query: [])
MyComponentClient.request(:post, url: "WeChatURL2", query: [])

Or use WeChat.request/2 directly

WeChat.request(:post, url: "WeChatURL1",
  appid: "MyAppID", authorizer_appid: "MyAuthorizerAppID",
  adapter_storage: {:default, "http://localhost:4000"}, body: %{}, query: [])

WeChat.request(:get, url: "WeChatURL2",
  appid: "MyAppID", authorizer_appid: "MyAuthorizerAppID",
  adapter_storage: {:default, "http://localhost:4000"}, query: [])