はじめに
TheDogAPI は、犬種のデータ、画像、写真解析を提供する REST API です。ペットのプロフィール、健康チェック、飼い主向けの品種コンテンツを作ったり、保険・動物病院・ペットフードの製品に品種データを加えたりできます。
1. API キーを取得する
サインアップすると、キーがメールで届きます。すべてのリクエストで x-api-key ヘッダーに入れて送ってください。詳しくは認証を、本番データに触れずにテストする方法はステージング環境と本番環境のアカウントをご覧ください。
2. 最初のリクエストを送る
curl -H "x-api-key: YOUR-API-KEY" https://api.thedogapi.com/v1/breeds/115
{
"id": "115",
"name": "German Shepherd",
…
}
すべてのエンドポイントは https://api.thedogapi.com/v1 以下にあります。うまくいかないときは、エラーと制限で各ステータスコードと再試行の目安を確認してください。
3. 作りたいものを選ぶ
| やりたいこと | 最初に読むもの |
|---|---|
| 品種の詳細、豆知識、健康のヒントを表示する | 飼い主向けコンテンツのための品種データ |
| 犬の画像を検索する、またはユーザーに自分の写真をアップロードしてもらう | 画像と画像のアップロード |
| 飼い主ごとにペットのプロフィールを用意する | ペットを作成する、次にペットとユーザーを紐づける |
| 写真から品種・年齢・体重を推定する | 品種の判定、年齢の推定、体重の推定 |
| 獣医師のレビュー付きで体型を評価する | ボディコンディションスコア |
| 1日のカロリーや減量プランを提案する | 1日のカロリーと減量プラン |
| 健康記録を継続して残す | ペットの健康履歴 |
| 結果を自分のサーバーに送ってもらう | Webhook |
すべてのガイドはガイドの概要にあります。すべてのエンドポイントとフィールドは API リファレンスにあります。
プラン
Free プランは学習や趣味のプロジェクト向けです。Startup プランでは、手頃な月額料金で商用ライセンス、より高いリクエスト上限、品種データの全項目が使えます。Enterprise プランでは、写真解析、健康記録、計算ツールが使えます。
品種の特徴（体重、体高、寿命）、豆知識、健康のヒントは Startup に含まれます。次の品種データはどのプランにも追加できます：食事のリスクと推奨、アレルゲン、ジョーク、品種別の心拍数と呼吸数、ドッグパーク、血統、画像ラベリング、歯の健康。
キーで何が有効になっているかは、GET /accounts/features を呼ぶか、有効にする機能を選ぶをご覧ください。Enterprise の利用と料金についてはお問い合わせください。