Contentful SDK
Contentful SDK

View Source Contentful (Contentful SDK v0.6.0)

The Contentful SDK provides helper functions and structs for a subset of the the available Contentful APIs and serves as a container for the shared structs.

The available Contentful APIs are:

setup

 Setup

In order to add the Contentful SDK add the following to your mix.exs:

# mix.exs

def deps do
  [
    # your other dependencies, then add:
    {:contentful, "~> 0.4"}
  ]
end

You can configure your access token(s) and Contentful environments via your local config.exs:

# in config.exs
config :contentful, json_library: Poison # optional, as Jason is the default

# per API definition:

config :contentful, delivery: [
  space_id: "<my_space_id>",
  access_token: "<my_cda_token>",
  environment: "<my_environment>" # defaults to `master`
]

config :contentful, management: [
  coming: :soon
]

config :contentful, preview: [
  coming: :soon
]

Please note that the default json_library that this SDK is tested with is Jason, yet Poison should be compatible.

Link to this section Summary

Functions

http_client()

The Tesla.client module to use.

json_library()

The JSON library to use. Can be either configured to Jason or Poison.

Link to this section Functions

Link to this function

http_client()

View Source 
@spec http_client() :: module()

The Tesla.client module to use.

By default, Contentful uses the standard Tesla.client. This can be overridden in config to use a custom dynamic client so that behaviour can be modified in runtime.

examples

 Examples 

# in lib/myapp/logging_client.ex
defmodule LoggingClient do
  # build dynamic client based on runtime arguments
  def client do
    middleware = [
      {Tesla.Middleware.Logger, debug: false}
    ]
    Tesla.client(middleware)
  end
end

# in config/config.exs
config :contentful, http_client: LoggingClient
Link to this function

json_library()

View Source 
@spec json_library() :: module()

The JSON library to use. Can be either configured to Jason or Poison.

examples

 Examples 

# in config/config.exs
config :contentful, json_library: Jason

iex> Contentful.json_library()
Jason