Skip to content

Latest commit

 

History

History
82 lines (63 loc) · 3.05 KB

README.md

File metadata and controls

82 lines (63 loc) · 3.05 KB
Raw

Postscript API client for Elixir

Installation

postscript is published on Hex. Add it to your list of dependencies in mix.exs:

defp deps do
  { :postscript, "1.0.0" }
end

postscript require you to provide an HTTP client and JSON codec. hackney and jason are used by default. If you wish to use these defaults you will also need to specify hackney and jason as dependencies.

Usage

Each resource module (e.g. Postscript.Trigger) provides functions for building a request that can be sent to the Postscript API using the Postscript.request/2 function.

Example

Postscript.Keyword.list() |> Postscript.request(api_key: "...")

For details on individual resource types please see our document on HexDocs.

Configuration

All configuration must be provided on a per-request basis as a keyword list to the second argument of Postscript.request/2.

Possible configuration values are provided below:

  • :api_key - private API key for making requests to Postscript resources
  • :http_client - client used when making HTTP requests. Defaults to Postscript.Http.Hackney.
  • :http_clients_opts - options or configuration passed to the HTTP client when a request is made. Defaults to [].
  • :http_host - host used to send requests to. Defaults to api.gopostscript.com.
  • :http_headers - additional HTTP headers to send as part of the request. Defaults to [].
  • :http_path - path appended to the :http_post when sending a request. Defaults to /v1.
  • :http_port - HTTP port used when sending a request
  • :http_protocol - HTTP protocol used when sending a request. Defaults to https.
  • :json_codec - JSON codec used to encode/decode request and response bodies. Defaults to Jason.
  • :retry - module implementing a strategy for retrying a request. Disable when set to false. Defaults to false.
  • :retry_opts - options sent to the retry strategy. Defaults to [],
    • :max_attempts - the number of attempts before failing a request. Defaults to 3.
  • :shop_token - private API key used for making a request on behalf of a Shopify shop

Retries

postscript has a built-in mechanism for retrying requests that either return an HTTP status code of 500 or a client error. You can enabled retries by providing a module that implements the Postscript.Retry behaviour to the :retry option when calling Postscript.request/2.

Currently, postscript provides a Postscript.Retry.Linear strategy for retrying requests. This strategy will automatically retry a request on a set interval. You can configure the interval by adding :retry_in with the number of milliseconds to wait before sending another request to the :retry_opts option.

Example

Postscript.Keyword.list() |> Postscript.request(retry: Postscript.Retry.Linear, retry_opts: [retry_in: 250])

The example above would retry a failed request after 250 milliseconds. By default Postscript.Retry.Linear will retry a request immediately if :retry_in has no value.