manaable REST API
What's manaableAbout Us
What's manaableAbout Us
    • Introduction
    • イントロダクション
    • API v3
      • Members
        • Get Members
        • Get Member by ID
      • Teams
        • Get Teams
        • Get Team by ID
    • API v2
    • API v1

    API v3

    Introduction はじめに#

    This documentation covers the API v3 endpoints of manaable.
    このドキュメントは、manaableのAPI v3エンドポイントをカバーします。

    Overview 概要#

    API covers resources: Members, Teams
    APIがカバーするリソース: メンバー、チーム

    Authentication 認証#

    The mode of authentication is API key.
    認証モードはAPIキーである。
    Key: api-key
    Value: API_KEY_HERE

    How to get API key APIキーの取得方法#

    i. Go to Admin screen of manaable.
    i. 管理者画面に移動する。
    ii. In the left navigation, under the 設定 option choose the 外部連携.
    ii. 左側のナビゲーションで、「設定」オプションの「外部連携」を選択する。
    image.png
    iii. Please find and take the API key from here.
    iii. こちらからAPIキーを取得してください。
    image.png

    API Custom Status Codes APIカスタムステータスコード#

    Code: 2000
    HTTP Code: 200
    Description: Successful Operation
    説明 オペレーション成功
    Code: 3000
    HTTP Code: 403
    Description: Invalid Token
    説明 無効なトークン
    Code: 4000
    HTTP Code: 500
    Description: Member Generic Error
    説明 メンバー汎用エラー
    Code: 4001
    HTTP Code: 404
    Description: Member Not Found
    説明 メンバーが見つかりません
    Code: 4004
    HTTP Code: 400
    Description: Invalid Data
    説明 無効なデータ
    Code: 5000
    HTTP Code: 500
    Description: Team Generic Error
    説明 チーム共通エラー
    Code: 5001
    HTTP Code: 404
    Description: Team Not Found
    説明 チームが見つかりません
    Modified at 2024-06-06 15:12:40
    Previous
    イントロダクション
    Next
    Get Members
    Built with