Godaddy

v0.4.0

Godaddy v0.4.0 Godaddy.Api View Source

Make generic HTTP calls a web service. Please update (or remove) the tests to a sample service in the examples below.

Link to this section Summary

Functions

call(atom, map)

Retrieve data from the API using either :get or :post

encode_body(map)

Encode the provided hash map for the URL

encode_body(arg1, map)
encode_headers()

Build the headers for your API

encode_headers(data)
get(source)

Make an API call using GET. Optionally provide any required headers

get(source, headers)
key()
patch(source)

Make an API call using PATCH. Optionally provide any required data and headers

patch(source, body)
patch(source, body, headers)
post(source)

Make an API call using POST. Optionally provide any required data and headers

post(source, body)
post(source, body, headers)
secret()
url()

Link to this section Functions

Link to this function call(atom, map) View Source

Retrieve data from the API using either :get or :post

Link to this function encode_body(map) View Source

Encode the provided hash map for the URL.

Examples 

iex> Godaddy.Api.encode_body(%{a: "one", b: "two"})
"{\"b\":\"two\",\"a\":\"one\"}"

iex> Godaddy.Api.encode_body(%{a: "o ne"})
"{\"a\":\"o ne\"}"

iex> Godaddy.Api.encode_body(nil, %{a: "o ne"})
"{\"a\":\"o ne\"}"

iex> Godaddy.Api.encode_body("application/x-www-form-urlencoded", %{a: "o ne"})
"a=o+ne"

iex> Godaddy.Api.encode_body("application/json", %{a: "b"})
"{\"a\":\"b\"}"
Link to this function encode_headers() View Source

Build the headers for your API

Examples 

iex> Godaddy.Api.encode_headers(%{content_type: "application/json", ssokey: {"pqr123", "mno456"}})
[{"Content-Type", "application/json"}, {"Authorization", "sso-key pqr123:mno456"}]

iex> Godaddy.Api.encode_headers(%{ssokey: {"pqr123", "mno456"}})
[{"Content-Type", "application/json"}, {"Authorization", "sso-key pqr123:mno456"}]

iex> Godaddy.Api.encode_headers(%{})
[{"Content-Type", "application/json"}, {"Authorization", "sso-key abc123:def456"}]

iex> Godaddy.Api.encode_headers()
[{"Content-Type", "application/json"}, {"Authorization", "sso-key abc123:def456"}]

iex> Godaddy.Api.encode_headers(nil)
[{"Content-Type", "application/json"}, {"Authorization", "sso-key abc123:def456"}]
Link to this function get(source) View Source

Make an API call using GET. Optionally provide any required headers

Link to this function patch(source) View Source

Make an API call using PATCH. Optionally provide any required data and headers

Link to this function patch(source, body, headers) View Source
Link to this function post(source) View Source

Make an API call using POST. Optionally provide any required data and headers

Link to this function post(source, body, headers) View Source