Scene 1:

API体験の概要

APIについて

crawl.batは、機能を組み合わせてAPIを作成できます。

機能 API 説明
HTTPトリガー リクエスト エンドポイントURL
通知 レスポンス バッチの成否
CL出力 レスポンス クローリングデータ

HTTPトリガー [リクエスト]

「HTTPトリガー」は、自動化実行のURLを発行するフックです。

ロボットをAPIにする場合、HTTPトリガーのURLをAPIのエンドポイントにします。

フック一覧

スケジュール 日時を予約して自動化を実行する
HTTPトリガー URLにアクセスして自動化を実行する。API用
メールトリガー メールを送信して自動化を実行する
シンプルフォーム フォームから自動化を実行する

通知 [レスポンス]

「通知」は、自動化を実行した際に通知するイベントの機能です。

通知種類をHTTPに設定することで、指定したURLでAPIのレスポンスを受け取れます。

CL出力 [レスポンス]

「CL出力」は、クローリングデータを出力するイベントの機能です。

出力種類をHTTPに設定することで、指定したURLでクローリングデータを受け取れます。

crawl.batは、機能を組み合わせてAPIを作成できます。

API体験について

使用するロボット

ロボットは、入門編 Act1で作成した「お知らせ投稿ロボット」を使用します。

チュートリアルのゴール

チュートリアルのゴールは、「HTTPトリガー」で発行したURLにリクエストして、「通知 (HTTP)」でレスポンスを受け取ります。

APIのテスト方法

テストサイトは、APIのテストができます。

テストサイト

APIリクエストのテスト

1.テストサイトに移動して、ログイン

2.「送信テスト画面」へ移動

左メニューのテストカテゴリに「送信テスト」があるので、送信テスト画面へ移動します。

3.「送信テスト画面」から送信

送信フォームボタンをクリックします。

 

送信フォームから、データを送信する事でAPIリクエストがテストできます。

送信テスト画面から、APIリクエストがテストできます。

APIレスポンスのテスト

1.テストサイトに移動して、ログイン

2.「送信テスト画面」へ移動

左メニューのテストカテゴリに「受信テスト」があるので、受信テスト画面へ移動します。

3.「受信先URL」へデータを送信

「受信先URL」をレスポンス先のURLにすることで、APIレスポンスがテストできます。

受信テスト画面から、APIレスポンスがテストできます。

ページの先頭へ