Event streamsパブリックAPI ​

Event streamsパブリックAPIは、イベントトピックからメッセージをパブリッシュおよび消費するためのエンドポイントを提供します。 このAPIは、イベントトピックを管理できるEvent streams Developer APIとは別のものです。

トピック内の各メッセージには、オフセットとして使用できるIDが含まれています。 これらのエンドポイントを使用するには、メッセージIDまたは最終メッセージタイムスタンプのいずれかを保存する必要があります。

詳細については、OpenAPI仕様を参照してください。

ベースURL ​

Event streamsパブリックAPIのベースURLは、Workatoアカウントがホストされているデータセンターによって異なります。 これらのURLは、メッセージのパブリッシュと消費を行うエンドポイントにのみ適用されます：

• USデータセンター：https://event-streams.workato.com
• EUデータセンター：https://event-streams.eu.workato.com
• JPデータセンター：https://event-streams.jp.workato.com
• SGデータセンター：https://event-streams.sg.workato.com
• AUデータセンター：https://event-streams.au.workato.com
• ILデータセンター：https://event-streams.il.workato.com
• CNデータセンター：https://event-streams.workatoapp.cn
• KRデータセンター：https://event-streams.kr.workato.com
• 開発者サンドボックス：https://event-streams.trial.workato.com

レート制限 ​

Event streams Developer APIリソースには、次のレート制限があります：

さらに、Event streamsパブリックAPIリソースには、次のペイロード制限があります：

クイックリファレンス ​

メッセージの消費 ​

トピックからメッセージを取得します。 このリソースでは、トピック内のすべてのメッセージを取得するか、リクエスト本文にパラメータを含めることで、指定したIDまたはタイムスタンプより後のメッセージを取得できます。 レスポンスは各バッチで最大50件のメッセージに制限されています。

timeout_secsパラメータを設定することで、ロングポーリングモードを有効にできます。 このモードでは、APIは利用可能なメッセージを即座に返します。 メッセージがない場合、APIは最大timeout_secs秒間待機します。 この時間内に新しいメッセージが表示されると即座に返されます。それ以外の場合、APIは呼び出しがタイムアウトした後に空のリストを提供します。

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

URLパラメーター ​

ペイロード ​

サンプルリクエスト ​

curl  -X POST "https://event-streams.workato.com/api/v1/topics/<id>/consume" \
      -H 'Authorization: Bearer <api_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パラメータ ​

ペイロード ​

サンプルリクエスト ​

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

レスポンス ​

{
  "message_id": "A1BRi"
}

メッセージのバッチのパブリッシュ ​

メッセージのバッチをトピックにパブリッシュします。 メッセージはトピックスキーマに準拠している必要があります。

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

URLパラメータ ​

ペイロード ​

サンプルリクエスト ​

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

レスポンス ​

{
  "is_partial_error": false,
  "message_ids": {
    "0": {
      "message_id": "A1DFi",
      "result": "success"
    },
    "1": {
      "message_id": "A1DL8",
      "result": "success"
    }
  }
}