概要
WebReaderAPIが動作しているかどうかを知るには？
APIキーを使ってGET https://webreaderapi.com/api/v1/creditsを呼び出します。これは無料で、正常な応答が返ればAPIとAPIキーが動作していることを意味します。ページが失敗した場合、エラーコードが理由を示し、WebReaderAPIではその分の課金はありません。当社側のインシデントは日付とともにchangelogに記録されています。
最速のヘルスチェックは何ですか？
クレジットエンドポイントです。ウェブサイトを取得せずに応答するため、当社側（認証、API、アカウント）のみをテストします。
curl -s https://webreaderapi.com/api/v1/credits -H "Authorization: Bearer $WEBREADER_API_KEY"
どのエラーがウェブサイト由来で、どれが当社由来ですか？
エラーコードが問題の場所を示します。これらのエラーはいずれもクレジットを消費しません。
| コード | 問題の場所 | 対処方法 |
|---|---|---|
blocked_by_robots | サイトのrobots.txtが当社のクローラーを拒否 | 何もしない：サイトが拒否している |
blocked_by_site_policy | サイトがai-input=noを宣言 | 何もしない：サイトが拒否している |
target_refused | サイトが403、429、チャレンジ、またはログインを返した | 後で試すか、サイトにアクセスを依頼する |
fetch_failed | DNS、TLS、接続、または404/410のページ | URLを確認し、後で再試行する |
fetch_timeout | サイトが時間内に応答しなかった | より長いtimeoutで再試行する |
concurrency_limit | アカウントからの同時リクエストが多すぎる | 速度を落とすか、上限の引き上げを依頼する |
invalid_api_key、insufficient_credits | APIキーまたは残高 | ダッシュボードを確認する |
エラーページでは、各ケースを再試行ループを含めて詳しく説明しています。
ここにリアルタイムの稼働率が表示されないのはなぜですか？
まだ公開サンプルで測定しておらず、でっち上げの数値は誤解を招くだけだからです。読み取りの成功率は主に読み取るサイトに依存するため、単一のパーセンテージではほとんど意味がありません。数値を公開する際は、方法、サンプル、日付を併記します。
インシデントはどこで告知されますか？
changelogで、日付、影響を受けたエンドポイント、実施した対応とともに告知されます。当社側で繰り返しエラー（対象サイトに起因しないコード）が発生する場合は、リクエスト時刻とエラーコードを添えて[email protected]までご連絡ください。
ステータス：よくある質問
クレジットの確認に費用はかかりますか？
いいえ。GET https://webreaderapi.com/api/v1/creditsはクレジットを消費しないため、同時実行の上限内であればヘルスチェックから何度でも呼び出せます。
ページが私の環境では失敗するのに、ブラウザでは開けます。なぜですか？
通常、サイトが人とロボットを異なる扱いをするためです。robots.txtで当社のクローラーを拒否したり、自動リクエストにチャレンジページで応答したりすることがあります。当社はその応答を返し、課金はしません。エラーコードとtarget_statusでサイトが返した内容を確認できます。
失敗した読み取りに課金されることはありますか？
いいえ。1クレジット = ブラウザなしでページを1回読み取り。ページのJavaScriptレンダリングにブラウザが必要な場合は2クレジット。失敗したリクエスト、またはサイトのrobots.txtが拒否したリクエストは課金されません。