# DNSimple Elixir Client
[](https://github.com/dnsimple/dnsimple-elixir/actions/workflows/ci.yml)
[](https://hex.pm/packages/dnsimple)
[](https://hexdocs.pm/dnsimple/)
[](https://hex.pm/packages/dnsimple)
[](https://github.com/dnsimple/dnsimple-elixir/blob/main/LICENSE.md)
[](https://github.com/dnsimple/dnsimple-elixir/commits/main)
An Elixir client for the [DNSimple API v2](https://developer.dnsimple.com/v2/).
## Requirements
* Elixir: 1.10+
* OTP: 21.0+
## Installation
You will have to add the `:dnsimple` app to your `mix.exs` file as a dependency:
```elixir
def deps do
[
{:dnsimple, "~> 1.0.0"}, #...
]
end
```
And then add it to the list of applications that should be started:
```elixir
def application do
[applications: [
:dnsimple, #...
]]
end
```
### Usage
#### From iex
```elixir
# Create a client passing the proper settings
iex> client = %Dnsimple.Client{access_token: "TOKEN", base_url: "https://api.sandbox.dnsimple.com/"}
# Check the login
iex> {:ok, response} = Dnsimple.Identity.whoami(client)
iex> response.data
# => %{"account" => %{"created_at" => "2014-05-19T14:20:32.263Z",
# => "email" => "example-account@example.com", "id" => 1,
# => "updated_at" => "2015-04-01T10:07:47.559Z"}, "user" => nil}
```
#### From an .exs file
```elixir
# Start Dnsimple app
Dnsimple.start
# Create a client passing the proper settings
client = %Dnsimple.Client{access_token: "TOKEN", base_url: "https://api.sandbox.dnsimple.com/"}
# Check the login
Dnsimple.Identity.whoami(client)
```
## Documentation
### Useful links
* [`dnsimple-elixir` hex.pm docs](https://hexdocs.pm/dnsimple/readme.html).
* [DNSimple API documentation](https://developer.dnsimple.com).
* [DNSimple API examples repository](https://github.com/dnsimple/dnsimple-api-examples).
* [DNSimple support documentation](https://support.dnsimple.com).
### Sandbox Environment
We highly recommend testing against our [sandbox environment](https://developer.dnsimple.com/sandbox/) before using our production environment. This will allow you to avoid real purchases, live charges on your credit card, and reduce the chance of your running up against rate limits.
The client supports both the production and sandbox environment. To switch to sandbox pass the sandbox API host using the `base_url` option when you construct the client:
```elixir
client = %Dnsimple.Client{base_url: "https://api.sandbox.dnsimple.com", access_token: "a1b2c3"}
```
You will need to ensure that you are using an access token created in the sandbox environment. Production tokens will *not* work in the sandbox environment.
### Configuration
You can configure DNSimple inside of your app's `config.exs`. For example, if you have a development config, inside `dev.exs`:
```elixir
config :dnsimple, base_url: "https://api.sandbox.dnsimple.com"
config :dnsimple, access_token: "secret"
config :dnsimple, user_agent: "my-app"
```
Now you can simply call `client = Dnsimple.Client.new_from_env()`.
### Logging
The client logs the requests made to the DNSimple API:
```elixir
iex(2)> Dnsimple.Identity.whoami(client)
09:45:08.229 [debug] [dnsimple] GET https://api.sandbox.dnsimple.com/v2/whoami
{:ok,
%Dnsimple.Response{data: %Dnsimple.Whoami{account: %Dnsimple.Account{email: "javier@dnsimple.com",
id: 63, plan_identifier: "dnsimple-professional"}, user: nil},
http_response: %HTTPoison.Response{...},
pagination: nil, rate_limit: 2400, rate_limit_remaining: 2398,
rate_limit_reset: 1482745464}}
```
The log level used for this is `debug`. If you want to disable it you will have to configure the logging level of your app (as it's set to `debug` level by default).
```elixir
config :logger, level: :info
```
### Examples
#### Authentication
```elixir
client = %Dnsimple.Client{base_url: "https://api.sandbox.dnsimple.com", access_token: "a1b2c3"}
{:ok, response } = Dnsimple.Identity.whoami(client)
```
You can get your `account_id` from the response, if you don't know it.
```elixir
account_id = response.data.account.id
```
#### Setting a custom `User-Agent` header
You customize the `User-Agent` header for the calls made to the DNSimple API:
```elixir
client = %Dnsimple.Client{user_agent: "my-app", access_token: "a1b2c3"}
```
The value you provide will be appended to the default `User-Agent` the client uses. For example, if you use `my-app`, the final header value will be `dnsimple-elixir/1.0 my-app` (note that it will vary depending on the client version).
#### Creating a domain
You will need:
* The `account_id` of the account you want to create the domain for.
* The `registrant_id` which is the ID of a contact of the corresponding account.
```elixir
client = %Dnsimple.Client{base_url: "https://api.sandbox.dnsimple.com", access_token: "a1b2c3"}
{:ok, response} = Dnsimple.Domains.create_domain(client, account_id = 1010, %{name: "example.com", registrant: registrant_id = 123})
```
#### Creating a record
You will need:
* The `account_id` of the account you want to create the domain for.
* The `zone_id` (can be the numeric ID or the name eg. "example.com").
```elixir
client = %Dnsimple.Client{base_url: "https://api.sandbox.dnsimple.com", access_token: "a1b2c3"}
{:ok, response} = Dnsimple.Zones.create_zone_record(client, account_id = 1010, zone_id = "example.com", %{
type: "CNAME",
name: "provider",
content: "dnsimple.com"
})
```
## License
Copyright (c) 2015-2023 DNSimple Corporation. This is Free Software distributed under the MIT license.
