ドキュメントに記載されたAPI連携
目的の操作が公式リファレンスに記載されていることを確認してから選んでください。
利点
- 最新のリファレンスで、必要な認証方法とリクエストの構造を確認できます。
- テスト環境では、本番システムに接続する前にレスポンスを調べられます。
注意点
- このページでは認証情報を発行できず、利用可能なClaidのエンドポイントも確認できません。
- 権限、入力要件、利用条件は公式情報で確認する必要があります。
開発者向けガイド
claid AI APIドキュメントの読み方
連携機能を実装する前に、公式リファレンスを特定し、最新の手順を確認してください。このClaidガイドでは確認すべき点を説明しますが、APIリファレンスではなく、利用可能なエンドポイント、認証情報、リクエスト例は提供していません。
前提条件
ドキュメントを実装計画として使う前に、プロジェクトに必要なのが自動化されたリクエストか、視覚的なワークフローかを判断してください。
視覚的な画像ワークフロー
ソフトウェアを書くよりも、画像の作成や評価が必要な場合に適した出発点です。
利点
- 連携を計画する前に、視覚的な結果を評価できます。
- サンプル画像と明確な目標があれば、具体的な評価基準を設けられます。
注意点
- 視覚的なワークフローがあっても、同等のAPI操作が存在する証拠にはなりません。
- 認証ルールやレスポンス形式も確認できません。
一連の流れを確認
承認済みの入力から送信、レスポンスの処理、人によるレビューまで、商品画像のサンプルタスクをたどります。リクエストの詳細はすべて最新のリファレンスで確認してください。
選択肢の比較表
この比較を使って、現行のAPIリファレンスで確認すべき事項と、画像を見ながら判断できる事項を切り分けましょう。
文書化されたAPIの利用手順
ビジュアルワークフロー
1
開始点
文書化されたAPIの利用手順
最新の公式リファレンスと、文書化された操作を確認します。
ビジュアルワークフロー
画像と具体的なビジュアル上の目標から始めます。
2
アクセス
文書化されたAPIの利用手順
リファレンスに記載された認証要件と権限要件に従います。
ビジュアルワークフロー
利用可能なインターフェースのアクセス手順に従います。
3
入力
文書化されたAPIの利用手順
文書化されたフィールド、ファイルに関するルール、サポートされる値のみを使用します。
ビジュアルワークフロー
見た目を評価するのに適した入力画像を選びます。
4
送信
ドキュメントに記載されたAPI経路
確認済みのドキュメントに基づいて作成したリクエストをテストします。
ビジュアルワークフロー
エンドポイントが存在すると決めつけず、インターフェースから作業結果を送信します。
5
結果
ドキュメントに記載されたAPI経路
ドキュメントに記載されたレスポンスを確認し、失敗したリクエストに対処します。
ビジュアルワークフロー
生成された画像に誤りや意図しない変更がないか確認します。
6
再現性
ドキュメントに記載されたAPI経路
確認済みの入力とレスポンスの処理方法をアプリケーションのメモに記録します。
ビジュアルワークフロー
次回の試行に備えて、元画像と確認基準を保管します。
うまくいかないこと
ガイドは最新のドキュメントの代わりにはならず、特定の連携がサポートされていることを証明するものでもありません。
- エンドポイントの推測
-
画面上の機能から推測した操作名が、呼び出し可能なAPI操作に対応しているとは限りません。
対処法リクエストを作成する前に、公式リファレンスでその操作を確認します。
- アクセス方法の決めつけ
-
このページでは、認証情報の種類、アカウントの権限、シークレットの送信方法を確認できません。
対処法最新の認証手順に従い、認証情報をクライアント側のコードに含めないでください。
- レスポンスのフィールドを推測で決める
-
画像URLやステータスのフィールドを推測して書いたコードは、リクエストの送信が成功しても動作しない場合があります。
対処法ドキュメントに記載されたレスポンスを確認し、成功時とエラー時の両方をテストしてください。
- 画像の確認を省く
-
リクエストが成功しても、出力画像が商品の細部を保持し、要件を満たしているとは限りません。
対処法テスト結果を後続の工程で使用する前に、元画像と比較して確認してください。
視覚的なテストを続ける
連携を計画する前に画像を評価する
画像ワークフローでどのような結果が得られるかをまず知りたい場合は、利用可能な製品機能を試してください。実装の詳細については、Claidの最新の公式リファレンスに戻り、リクエストの各値を確認してください。
- 使用が許可された元画像を用意してください。
- 成功した結果で保持されるべき要素を定義してください。
- 見た目の結果とAPIでの利用可否は、別々に判断してください。
専用のFAQ
公式の製品チャネルまたは開発者向けチャネルで公開されている最新のリファレンスを探し、使用したい操作が記載されているか確認してください。このガイドは概要を示すものであり、公式のエンドポイントリファレンスではありません。無関係な例に記載されているというだけで、エンドポイントや認証方法を使用しないでください。
いいえ。実際に動作するリクエストには、操作、認証方法、受け付けられる入力、必須フィールドなど、確認済みの詳細情報が必要です。もっともらしいリクエストを、それらの詳細を確認せずにコピーすると、エラーが発生したり、認証情報が漏洩したりする可能性があります。
利用要件、入力に関する正確なルール、リクエストの構造、レスポンスで成功または失敗がどのように示されるかを確認してください。用途に関係する制限が記載されていれば、それも確認してください。使用が許可されたサンプル画像を使い、訪問者のブラウザーで実行されるコードに秘密情報を含めないでください。
いいえ。インターフェースとAPIでは提供される操作が異なる場合があるため、画面上で画像を編集できても、対応するエンドポイントがあるとは限りません。最新のリファレンスでAPIの対応状況を確認してから、記載された操作をテストし、その出力を別途確認してください。