Developer API ​

Developer APIは、レシピ、コネクション、ジョブなどを管理できる幅広いWorkatoリソースへのアクセスを提供します。 このAPIを使用すると、Development EnvironmentとプロダクションEnvironment間でのレシピマニフェストのデプロイから、ネットワーク環境内での新しいオンプレミスエージェントのロールアウトまで、Workatoワークスペースのあらゆる側面を自動化できます。

ベースURL ​

Workato APIは、Workatoユーザー、レシピなどとやり取りするためのAPIエンドポイントの集合です。 各エンドポイントには、オブジェクトへのベースURLとリソースパスが含まれます。

APIエンドポイントのベースURLは、使用するデータセンターによって異なります:

• USデータセンター: https://www.workato.com/api/
• EUデータセンター: https://app.eu.workato.com/api/
• JPデータセンター: https://app.jp.workato.com/api/
• SGデータセンター: https://app.sg.workato.com/api/
• AUデータセンター: https://app.au.workato.com/api/
• ILデータセンター: https://app.il.workato.com/api/
• CNデータセンター: https://app.workatoapp.cn/api/
• KRデータセンター: https://app.kr.workato.com/api/
• Developerサンドボックス: https://app.trial.workato.com/api/

認証 ​

Workato APIはAPIトークンを使用してリクエストを認証します。 APIトークンは、ワークスペース管理者でAPIクライアントを作成し、クライアントロールとプロジェクトスコープの両方を割り当てることで生成できます。

APIトークンをbearerトークンとして指定する ​

APIクライアントのAPIトークンを、Bearerトークンとしてリクエストヘッダーに指定します。

curl  -X GET https://www.workato.com/api/users/me \
      -H 'Authorization: Bearer <api_token>'

サポートされている形式 ​

Workato APIは、application/jsonコンテンツタイプでのリクエスト本文の送信をサポートしています。 すべての応答もapplication/json; charset=utf-8でエンコードされます。

APIトークンの生成方法 ​

APIトークンは、ワークスペース管理者＞APIクライアントでAPIクライアントを作成することで生成できます。 詳細はAPIクライアントとロールの設定を参照してください。

HTTPレスポンスコード ​

• 200 成功
• 400 不正なリクエスト
• 401 未認証
• 403 禁止
• 404 見つかりません
• 500 サーバーエラー

200 成功 ​

200 Successレスポンスは、リクエストがサーバーによって正常に処理されたことを示します。 レスポンス本文は、実行されたエンドポイントとオペレーションによって異なりますが、通常はリクエストされたデータ、または実行されたアクションの確認が含まれます。

サンプル応答 ​

{
    "success": true
}

400 Bad Request ​

400 Bad Requestエラーは、クライアント側の問題によりサーバーがリクエストを処理できなかったことを示します。 一般的な原因には、不正な形式のリクエスト、無効なフィールド、サポートされていないデータ型などのフィールド制約違反が含まれます。

サンプル応答 ​

{
    "errors": [
        {
            "code": 400,
            "title": "No workspaces found matching the specified workspace filter conditions."
        }
    ]
}

401 Unauthorized ​

401 Unauthorizedエラーは、リクエストに有効な認証資格情報がない場合に返されます。 一般的な原因には、トークンの欠落、無効なトークン、または誤った資格情報が含まれます。

サンプル応答 ​

{
    "errors": [
        {
            "code": 401,
            "title": "未認証"
        }
    ]
}

403 禁止 ​

403 Forbiddenエラーは、クライアントは認証されているものの、リクエストされたリソースにアクセスするために必要な権限がないことを示します。

サンプル応答 ​

{
    "errors": [
        {
            "code": 403,
            "title": "禁止"
        }
    ]
}

404 Not Found ​

404 Not Foundエラーは、リクエストされたリソースが存在しない場合、または見つからない場合に返されます。 これは、URLが正しくない場合、またはリソースが削除されている場合に発生することがあります。

サンプル応答 ​

{
    "errors": [
        {
            "code": 404,
            "title": "見つかりません"
        }
    ]
}

500 サーバーエラー ​

500 Server Errorコードは、サーバーが予期しない状況に遭遇し、リクエストを完了できなかったことを示します。 このエラーは通常、サーバー側の問題が原因で発生します。

サンプル応答 ​

{
    "errors": [
        {
            "code": 500,
            "title": "サーバーエラー",
            "detail": "3188c2d0-29a4-4080-908e-582e7ed82580"
        }
    ]
}

x-correlation-idの使用 ​

Developer APIでx-correlation-idを使用して、リクエストを追跡および関連付けできます。 これにより、デバッグ、トレーサビリティ、およびロギングが向上します。

リクエストヘッダーに独自のx-correlation-idを指定することも、Workatoに生成させることもできます。 独自のx-correlation-idを指定すると、応答には指定したx-correlation-idとWorkatoからのx-correlation-idの両方が含まれます。