# NETRecordAPI

## DNS Record API リファレンス

### サービス名

**DNS Record API**

### 利用用途

`DNS Record API`は、指定されたホスト名に関連するDNSレコードを取得するためのAPIです。このAPIを使用することで、DNSレコードの種類（A、CNAME、MXなど）に応じた情報を取得し、ネットワーク管理やドメイン解析などに活用できます。

***

### API エンドポイント

```
https://events-front.mixeder.net/v1/recordapi
```

***

### パラメータ

| パラメータ  | 必須 | 説明                           |
| ------ | -- | ---------------------------- |
| `key`  | 必須 | 利用者のAPIキー                    |
| `host` | 必須 | DNSレコードを取得するホスト名             |
| `type` | 任意 | DNSレコードのタイプ（例: A、CNAME、MXなど） |

***

### 利用方法

1. 有効なAPIキーを用意します。
2. 取得したいDNSレコードのホスト名を`host`パラメータに指定します。
3. オプションで、取得するDNSレコードのタイプを`type`パラメータに指定します（指定がない場合はデフォルトでAレコードが取得されます）。
4. APIリクエストを送信すると、指定されたホスト名に関連するDNSレコードがJSON形式で返されます。

***

### サンプルコード

#### cURL

```bash
curl "https://events-front.mixeder.net/v1/recordapi?key=YOUR_API_KEY&host=example.com&type=A"
```

#### Node.js

```javascript
const https = require('https');

const url = 'https://events-front.mixeder.net/v1/recordapi?key=YOUR_API_KEY&host=example.com&type=A';

https.get(url, (res) => {
    let data = '';
    res.on('data', (chunk) => {
        data += chunk;
    });
    res.on('end', () => {
        console.log(data);
    });
}).on('error', (err) => {
    console.error('Error: ' + err.message);
});
```

#### Python

```python
import requests

url = "https://events-front.mixeder.net/v1/recordapi/"
params = {
    "key": "YOUR_API_KEY",
    "host": "example.com",
    "type": "A"
}

response = requests.get(url, params=params)
if response.status_code == 200:
    print(response.text)
else:
    print(f"Error: {response.status_code}")
```

***

### エラーメッセージ

* **API Key not provided.**: APIキーが指定されていません。
* **Hostname not provided.**: ホスト名が指定されていません。
* **API key is wrong**: APIキーが無効です。
* **Error**: DNSレコードの取得に失敗しました。

***

### 注意事項

* 有効なAPIキーが必要です。指定がない場合や無効な場合はリクエストは拒否されます。
* `host`パラメータには、DNSレコードを取得したいホスト名を正確に指定してください。
* `type`パラメータには、取得したいDNSレコードのタイプを指定できます。無効なタイプが指定された場合は、デフォルトのAレコードが取得されます。