Event streamsパブリックAPI ​

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

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

詳細については、ご利用のデータセンターのベースURLにある/api/v1/openapi.jsonのOpenAPI仕様を参照してください。

ベースURL ​

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

Workato Enterpriseのお客様 ​

• 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
• UKデータセンター：https://event-streams.uk.workato.com

Self-service（Workato Free、Workato Pro、またはDeveloper Sandbox）ユーザー ​

• セルフサービスデータセンター: https://event-streams.trial.workato.com

レート制限 ​

Event streams Developer APIリソースには、次のレート制限が適用されます。

加えて、Event streams public APIリソースには次のペイロードクォータが適用されます。

クイックリファレンス ​

メッセージの取得 ​

トピックからメッセージを取得します。このリソースでは、トピック内のすべてのメッセージを取得するか、リクエストボディにパラメータを含めることで、指定したIDまたはタイムスタンプ以降のメッセージのみを取得するかを選択できます。レスポンスはバッチごとに最大50件のメッセージに制限されています。

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

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

URLパラメータ ​

ペイロード ​

サンプルリクエスト ​

curl  -X POST "https://YOUR_EVENT_STREAMS_DC/api/v1/topics/:topic_id/consume" \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      --data '{"after_message_id": ":after_message_id"}'

レスポンス ​

{
    "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 https://YOUR_EVENT_STREAMS_DC/api/v1/topics/:topic_id/publish

URLパラメータ ​

ペイロード ​

サンプルリクエスト ​

curl  -X POST "https://YOUR_EVENT_STREAMS_DC/api/v1/topics/:topic_id/publish" \
      -H 'Authorization: Bearer <api_token>' \
      --data '{":field_name_1": ":field_value_1", ":field_name_2": ":field_value_2"}'

レスポンス ​

{
  "message_id": "A1BRi"
}

メッセージバッチの公開 ​

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

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

URLパラメータ ​

ペイロード ​

サンプルリクエスト ​

curl  -X POST "https://YOUR_EVENT_STREAMS_DC/api/v1/batch/topics/:topic_id/publish" \
      -H 'Authorization: Bearer <api_token>' \
      --data '{"payloads":[{":field_name_1": ":field_value_1a", ":field_name_2": ":field_value_2a"},
      {":field_name_1": ":field_value_1b", ":field_name_2": ":field_value_2b"}]}'

レスポンス ​

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