PubSub

PubSub APIは、PubSubトピックからメッセージを公開および取得するためのものです。トピック内の各メッセージには、オフセットとして使用されるIDがあります。このエンドポイントを使用するには、メッセージIDまたは最後のメッセージのタイムスタンプを保存する必要があります。

WORKATO PUBSUBの新しいAPIドメイン

Workatoは、PubSub APIを新しいドメイン「event-streams.workato.com (opens new window)」に移行しました。 www.workato.com/apiで公開されている旧ドメインは引き続き動作しますが、1分あたりのリクエスト数は1000に制限されます。 (opens new window) 旧ドメインは、このページにリストされている要求と応答の形式をサポートしています。

クイックリファレンス

タイプ	リソース	説明
POST	/api/v1/topics/:topic_id/consume	トピックからメッセージを取得します。
POST	/api/v1/topics/:topic_id/publish	トピックにメッセージを公開します。

メッセージの取得

トピックからメッセージを取得します。

POST /api/v1/topics/:topic_id/consume

URLパラメータ

名前	タイプ	説明
topic_id	integer 必須	PubSubトピックID。

ペイロード

名前	タイプ	説明
after_message_id	string オプション	メッセージID。指定したIDのメッセージ以降のすべてのメッセージがサービスから返されます。IDは、トピックに存在するメッセージに対応している必要があります。
since_time	string オプション	RFC 3339形式のタイムスタンプ。指定したタイムスタンプ以降のすべてのメッセージがサービスから返されます。

サンプルリクエスト

curl  -X POST "https://event-streams.workato.com/api/v1/topics/<id>/consume" \
      -H 'Authorization: Bearer <token>' \
      -H 'Content-Type: application/json' \
      --data '{"after_message_id": "A12x"}'

レスポンス

{
    "messages": [
        {
            "message_id": "A12y",
            "payload": {
                "Name": "Jane",
                "Surname": "Doe"
            },
            "time": "2023-04-14T15:07:14.437+00:00"
        },
        {
            "message_id": "A12z",
            "payload": {
                "Name": "John",
                "Surname": "Doe"
            },
            "time": "2023-04-14T15:43:40.227+00:00"
        }
    ]
}

メッセージの公開

トピックにメッセージを公開します。メッセージはトピックのスキーマに準拠している必要があります。

POST /api/v1/topics/:topic_id/publish

URLパラメータ

名前	タイプ	説明
topic_id	integer 必須	PubSubトピックID。

ペイロード

名前	タイプ	説明
	JSON 必須	トピックに公開するメッセージ。メッセージはトピックスキーマに準拠している必要があります。

サンプルリクエスト

curl  -X POST "https://event-streams.workato.com/api/v1/topics/<id>/publish" \
      -H 'Authorization: Bearer <token>' \
      --data '{"Name": "John", "Surname": "Doe"}'

レスポンス

{
    "message_id": "A1BRi"
}