リクエストを出す | ドキュメント | Screenshot API | WhoisXML API

リクエストを出す

APIエンドポイント

GET https://website-screenshot.whoisxmlapi.com/api/v1?apiKey=YOUR_API_KEY&url=google.com&credits=DRS
アカウントの登録後、有効化に最大1分かかります。

Postman Collection

Postmanは、GUIからAPIへのリクエストを可能にするデスクトップおよびウェブのアプリケーションです。APIの機能を活用する際、およびアプリケーションのトラブルシューティングにあたっては、PostmanとWhoisXML APIエンドポイントのご利用をお勧めします。

WhoisXML API Postman Collectionは、以下のリンクから入手できます:

コレクションの環境はあらかじめ設定されたものです。各リクエストを起動するためには、api_key変数を設定する必要があります。 個人用API KEYは、My productsページで取得してください。APIに関するご質問は、こちらにお送りください。

入力パラメータ

apiKey

必須My productsページでAPI KEYを取得してください。

url

必須。対象ウェブサイトのURL。

ポート番号の指定にも対応しています(例:example.com:80)。

URLに「&, ?, #, =」などの「特殊文字」が含まれている場合は、URLをエンコードする必要があります。

credits

任意

SA:Screenshot APIのクレジットは、APIが呼び出された時に計算されます。

DRS:Domain Research Suiteのクレジットは、APIが呼び出された時に計算されます。

使用可能な値:SA | DRS

初期値:SA

imageOutputFormat

任意。応答の出力形式。

使用可能な値:image | base64

初期値:image

errorsOutputFormat

任意。エラーの出力形式。

使用可能な値:JSON | XML

初期値:JSON

type

任意。画像出力の種類。

使用可能な値:jpg | png | pdf

初期値:jpg

quality

任意。画質。(jpgタイプのみ)。

使用可能な値:40 < quality < 99

初期値:jpg

width

任意。画像の幅(px)。

使用可能な値:100 < width < 3000

初期値:800

height

任意。画像の高さ(px)。

使用可能な値:100 < width < 3000

初期値:600

thumbWidth

任意。画像のサムネイルの幅(px)。

使用可能な値:50 < thumbWidth < widthパラメータの値

初期値:0

mode

任意

fast:document.loadイベントを待機。

slow:ネットワークのアイドルイベントを待機。

使用可能な値:fast | slow

初期値:fast

scroll

任意。指定した場合(任意の値)、スクロールダウンしてscrollPositionに移動します (ページ全体のスクリーンショットに便利です)。

scrollPosition

任意scrollの動作を指定。

使用可能な値:top | bottom

初期値:top

fullPage

任意。指定された場合(任意の値)、ページ全体のスクリーンショットを作成します。

noJs

任意。指定された場合(任意の値)、JSを無効にします。

delay

任意。画面キャプチャ前のカスタム遅延(ms)。

使用可能な値:0 < delay < 10000 ms

初期値:250

timeout

任意。ページ読み込みのカスタムタイムアウト(ms)。指定したタイムアウト内にサーバーがページをロードできない場合、APIはエラーで応答します。

使用可能な値:1000 < timeout < 30000 ms

初期値:15000

scale

任意。エミュレータのdeviceScaleFactorの値。

使用可能な値:0.5 < scale < 4.0

初期値:1.0

retina

任意。指定した場合(任意の値)、Retinaディスプレイをエミュレートします。

ua

任意。「User-Agent」ヘッダーの文字列。

cookies

任意name1=value1;name2=value2という形式の「Cookie」ヘッダーの文字列。

クエリの文字列が正しくエンコードされていることを確認してください。

mobile

任意。指定した場合(任意の値)、モバイルデバイスをエミュレートします。

touchScreen

任意。指定した場合(任意の値)、タッチスクリーンを持つデバイスをエミュレートします。

landscape

任意。指定した場合(任意の値)、ページをランドスケープモードでレンダリングします(スマートフォンのエミュレーションに便利です)。

failOnHostnameChange

任意。指定した場合(任意の値)、リダイレクトにより対象ドメイン名が変更された時に、APIはHTTPエラーコード422で応答します。

無料アクセス

アカウントのご登録後、最大500 DRSクレジットが無料になるサブスクリプションプランが自動的に適用されます。

使用量の上限とリクエストのスロットリング

1分あたりの最大リクエスト数は120です。この上限を超えた場合、それ以降のリクエストは次の分まで拒否されます。

プレミアムAPIサービスおよびエンタープライズAPIパッケージでご提供するAPIでは、専用のロードバランサーとプレミアムエンドポイントにより、さらに高速なクエリが可能です。