DozensAPIClient 1.1.2

This library provide you to easily access way to API of "Dozens" DNS service (ex.Create/Get/Udate/Edit DNS zones or records).
     クラウド時代に対応したDNSサービス "Dozens"(https://dozens.jp/) の REST API にアクセスして、ゾーン又はレコードの追加/取得/変更/削除を行うことのできる、.NET 言語用のクラスライブラリです。

Install-Package DozensAPIClient -Version 1.1.2
dotnet add package DozensAPIClient --version 1.1.2
<PackageReference Include="DozensAPIClient" Version="1.1.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add DozensAPIClient --version 1.1.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Dozens API Client for .NET (and COM) NuGet Package Build status

Summary / 概要

クラウド時代に対応した DNSサービス "Dozens" https://dozens.jp の REST API を呼び出して、
ゾーンやレコードの追加・取得・変更・削除を行うことができる、C# で書かれたクライアントアクセスライブラリです。

C# からはもちろん、F# スクリプトや Windows PowerShell などの .NET Framework を利用可能な処理系から利用可能なほか、
COM サーバーとして登録することで、VBSvript や JScript、VB6 などからも利用することが可能です。

NuGet にもパッケージとして登録済みです。

https://www.nuget.org/packages/DozensAPIClient/

ですので、例えばパッケージマネージャコンソールから以下のコマンドを実行するなどの手順により、
容易に自分のプロジェクトに Dozens API Client を追加することができます。

# Package Manager Console
PM> Install-Package DozensAPIClient
# .NET CLI
>  dotnet add package DozensAPIClient

System Requirements / システム要件

  • .NET Framework 3.5 以降
  • 又は .NET Core 1.1 以降

Notice / 注意

This class library dose not work at ".NET Framework 3.5 Client Profile".

「.NET Framework 3.5 Client Profile」上では動作しません。

How to get API Key / API キーの入手方法

It is needed to access Dozens API that Dozens user ID and API key for your Dozens account.
You can get API key from "prfile" page on Dozens controll panel site.

Dozens API にアクセスするには、Dozens ユーザーIDと API キーが必要です。
API キーは Dozens のコントロールパネルサイトにある "プロフィール" ページから取得できます。

fig.1

Usage - C# Sample Code / 使い方 - C# サンプルコード

using DozensAPI;
...

// Create Dozens API client object with credential.
// (認証情報とともに Dozens API クライアントオブジェクトを生成)
var dozens = new Dozens("{userId}", "{apiKey}");

// Create zone. (ゾーンを作成)
dozens.CreateZone("example.com");

// Get all zones. (全てのゾーンを取得)
var zones = dozens.GetZones();
foreach (var zone in zones) {
  Console.WriteLine(zone.Name);
}

// Delete zone. (ゾーンの削除)
dozens.DeleteZone("example.com");

// Create DNS record in specified zone.
// (指定したゾーンに DNS レコードを作成)
dozens.CreateRecord("example.net", "www", "A", 0, "192.168.0.101", 7200);

// Get all DNS records in specified zone.
// (指定したゾーンのすべての DNS レコードを取得)
var records = dozens.GetRecords("example.net");
foreach (var record in records) {
  Console.WriteLine($"{record.Name},{record.Type},{record.Prio},{record.Content},{record.TTL}")
}

// Update DNS record. (DNS レコードの更新)
dozens.UpdateRecord("example.net", "www", 0, "192.168.0.102", 7200);

// Delete DNS record. (DNS レコードの削除)
dozens.DeleteRecord("example.net", "www");

Usage / 使い方 - YouTube Videos

F# Script Edition / F# スクリプト版

http://youtu.be/ziklLtz08og

C# Console App Edition / C# コンソールアプリ版

http://youtu.be/it_WeNAeeds

Windows PoerShell Edition / Windows PowerShell 版

http://youtu.be/3EQVmKplISo

VBScript Edition / VBScript 版

http://youtu.be/DDLL8fpPAa4

Extra - Microsoft Small Basic

"Dozens API Client for Small Basic" http://dozens4smallbasic.codeplex.com をインストールすると、
Microsoft Small Basic http://smallbasic.com/ からも Dozens の REST API を呼び出して自由に DNS を構成することができます。

http://youtu.be/a5bKMkI0P4M

ライセンス / License

Mozilla Public License Version 2.0

Dozens API Client for .NET (and COM) NuGet Package Build status

Summary / 概要

クラウド時代に対応した DNSサービス "Dozens" https://dozens.jp の REST API を呼び出して、
ゾーンやレコードの追加・取得・変更・削除を行うことができる、C# で書かれたクライアントアクセスライブラリです。

C# からはもちろん、F# スクリプトや Windows PowerShell などの .NET Framework を利用可能な処理系から利用可能なほか、
COM サーバーとして登録することで、VBSvript や JScript、VB6 などからも利用することが可能です。

NuGet にもパッケージとして登録済みです。

https://www.nuget.org/packages/DozensAPIClient/

ですので、例えばパッケージマネージャコンソールから以下のコマンドを実行するなどの手順により、
容易に自分のプロジェクトに Dozens API Client を追加することができます。

# Package Manager Console
PM> Install-Package DozensAPIClient
# .NET CLI
>  dotnet add package DozensAPIClient

System Requirements / システム要件

  • .NET Framework 3.5 以降
  • 又は .NET Core 1.1 以降

Notice / 注意

This class library dose not work at ".NET Framework 3.5 Client Profile".

「.NET Framework 3.5 Client Profile」上では動作しません。

How to get API Key / API キーの入手方法

It is needed to access Dozens API that Dozens user ID and API key for your Dozens account.
You can get API key from "prfile" page on Dozens controll panel site.

Dozens API にアクセスするには、Dozens ユーザーIDと API キーが必要です。
API キーは Dozens のコントロールパネルサイトにある "プロフィール" ページから取得できます。

fig.1

Usage - C# Sample Code / 使い方 - C# サンプルコード

using DozensAPI;
...

// Create Dozens API client object with credential.
// (認証情報とともに Dozens API クライアントオブジェクトを生成)
var dozens = new Dozens("{userId}", "{apiKey}");

// Create zone. (ゾーンを作成)
dozens.CreateZone("example.com");

// Get all zones. (全てのゾーンを取得)
var zones = dozens.GetZones();
foreach (var zone in zones) {
  Console.WriteLine(zone.Name);
}

// Delete zone. (ゾーンの削除)
dozens.DeleteZone("example.com");

// Create DNS record in specified zone.
// (指定したゾーンに DNS レコードを作成)
dozens.CreateRecord("example.net", "www", "A", 0, "192.168.0.101", 7200);

// Get all DNS records in specified zone.
// (指定したゾーンのすべての DNS レコードを取得)
var records = dozens.GetRecords("example.net");
foreach (var record in records) {
  Console.WriteLine($"{record.Name},{record.Type},{record.Prio},{record.Content},{record.TTL}")
}

// Update DNS record. (DNS レコードの更新)
dozens.UpdateRecord("example.net", "www", 0, "192.168.0.102", 7200);

// Delete DNS record. (DNS レコードの削除)
dozens.DeleteRecord("example.net", "www");

Usage / 使い方 - YouTube Videos

F# Script Edition / F# スクリプト版

http://youtu.be/ziklLtz08og

C# Console App Edition / C# コンソールアプリ版

http://youtu.be/it_WeNAeeds

Windows PoerShell Edition / Windows PowerShell 版

http://youtu.be/3EQVmKplISo

VBScript Edition / VBScript 版

http://youtu.be/DDLL8fpPAa4

Extra - Microsoft Small Basic

"Dozens API Client for Small Basic" http://dozens4smallbasic.codeplex.com をインストールすると、
Microsoft Small Basic http://smallbasic.com/ からも Dozens の REST API を呼び出して自由に DNS を構成することができます。

http://youtu.be/a5bKMkI0P4M

ライセンス / License

Mozilla Public License Version 2.0

Release Notes

v.1.1.2
     - Dozens API のアクセスプロトコルを http から https に変更
     - Auth メソッドで認証失敗時、DozensException 例外が発射されず、生の WebException が発射される不具合を修正
     v.1.1.1
     - .NET Core 1.1 に対応
     - ゾーンまたはレコード取得が0件のときに例外発生する不具合を修正
     v.1.1.0.1
     - CodePlex から GitHub への引き揚げに伴い、NuGet パッケージ中のプロジェクトサイト URL などを更新
     - ライセンスを Ms-PL から Mozilla Public License Version 2.0 に変更
     v.1.1.0
     - VBScript など WSH 環境からも呼び出せるよう、COM 相互運用の属性を追加、署名
     - PowerShell 2.0 で使えるよう対象フレームワークを .NET4 から .NET3.5 に格下げ
     v.1.0.0
     - 1st Release

  • .NETFramework 3.5

    • No dependencies.
  • .NETFramework 4.5

    • No dependencies.
  • .NETStandard 1.6

  • UAP 0.0

    • No dependencies.

This package is not used by any popular GitHub repositories.

Version History

Version Downloads Last updated
1.1.2 298 8/21/2017
1.1.1.2 255 8/20/2017
1.1.0.1 247 8/11/2017
1.1.0 1,555 7/27/2011
1.0.0 719 7/19/2011