API ドキュメント

API に接続して統合する方法を学びます。

独自の API キーを取得する

ベース URL

認証

すべての API エンドポイントには、ベアラー認証メソッドによって送信される API キーが必要です。

Authorization: Bearer {api_key}

例

curl --request GET \
--url 'https://mybotsy.com/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \

エラー

当社の API は、従来の HTTP ステータスコードを使用してリクエストの成功または失敗を示します。

例

{
    "errors": [
        {
            "title": "API \u306b\u30a2\u30af\u30bb\u30b9\u3067\u304d\u307e\u305b\u3093\u3002",
            "status": 401
        }
    ]
}

ステータスコード

200 リクエストは正常に完了しました

400 不正なリクエスト - 必須パラメータが欠落しているか無効です

401 権限がありません - API キーが見つからないか無効です

404 要求されたリソースが見つかりませんでした

429 リクエストが多すぎます - レート制限を超えました

500 内部サーバーエラー - これは、弊社側に問題があることを意味します

特に指定がない限り、すべての API エンドポイントの結果はUTC タイムゾーンで機能します。

ユーザー

チーム

チームメンバー

Teams のメンバー

アカウントログ