RelvoカタログにAPIを掲載する
API、そのドキュメント、チームへの連絡方法をお送りください。以下の要件と照らし合わせ、公開されている料金で実際の呼び出しを実行し、各エンドポイントの料金とともにカタログへ追加します。
まず要件を確認してください
規模やカテゴリにかかわらず、すべてのプロバイダーに同じチェックリストを適用します。
まず対象条件を確認してください。必須要件は、セルフサービスのAPIキー（営業との通話なし）、キーがヘッダーかクエリパラメータで渡されること（URLパスは不可）、無効なキーを区別できる応答で拒否する無料またはほぼ無料の疎通確認用エンドポイント、公開された料金ページ、そして入力例付きのドキュメントです。
どれかが欠けている場合は、その旨をメッセージに記載してください。1項目が満たせないプロバイダーでも、修正後に掲載できます。ただし、検証できない呼び出しに料金を付けることはできません。
以下をすべて1通にまとめて
完全な掲載情報は一度で確認できます。不足があると往復が増えます。
- プロバイダー。サービスのスラッグ、表示名、ベースURL、認証方式、カテゴリ、1行の概要、ドキュメントのURL。
- 疎通確認。エージェントがキーの有効性を確認するための安価なエンドポイント1つと、無効なキーに対してAPIが返す応答。
- エンドポイント。エージェントが実際に使う8〜15のエンドポイント。それぞれに機能、型付きの入力パラメータ、安価なテストリクエスト、根拠（料金ページやレートカード）付きの費用。
- マーク。正方形のロゴファイル、またはサイト上のロゴを使用する許可。
- 連絡先。チームのメールアドレス。テスト用の認証情報の調整と、掲載内容の送付に使います。
提案する前に再利用する
機能はエージェントがプロバイダーを比較する単位なので、重なりは狙いどおりであり、重複ではありません。
各エンドポイントについて、機能を名付ける前に：
- 再利用。その仕事でカタログを検索します。機能がすでにある場合は、似た別名を作らずそのIDを使ってください。
- 欠けているときだけ提案。同じ仕事をするエンドポイントが別プロバイダーにあり、機能がそれをカバーしていない場合は、1つ提案し、そのエンドポイントをメッセージで示してください。
- 重なりを歓迎。同じ機能を共有するエンドポイントこそ、エージェントが比較し振り分ける対象であり、掲載の価値になります。
すべてのテストリクエストを自分のキーで実行する
ドキュメントは古くなりますが、メーターは変わりません。送る料金は、実際にアカウントへ請求された額であるべきです。
掲載情報を送る前に、すべてのテストリクエストをご自身のアカウントで実行し、各費用をメーターの請求額と突き合わせてください。料金が当てはまる環境・リージョン・プランと、確認した日付を明記します。
サンプル応答は、ドキュメントで公開されている場合にのみ送ってください。認証情報の値をメッセージに含めないでください。
確認、実地テスト、公開
どの掲載も、カタログに表示される前に同じ実地確認を通ります。
実際のキーと無効なキーで疎通確認エンドポイントを呼び、2つの応答が区別できることを確認し、提示された費用をメーターと突き合わせます。一致しない場合は、失敗した正確な呼び出しを添えて返信します。
合格すると、プロバイダーはツール配下に専用ページを持ち、エンドポイントにはカタログページが付きます。料金は公開レートで呼び出しごとです。開始するにはinfo@relvo.siまでご連絡ください。