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
      • Trainings
        • List trainings / 研修一覧取得
        • Count trainings / 研修件数取得
        • Get training custom field definitions / 研修カスタムフィールド定義取得
        • Get training by ID / 研修詳細取得
        • Update training / 研修情報更新
        • Delete training / 研修削除
      • Applicants
        • List applicants / 申込者一覧取得
        • Bulk create/update applicants (upsert) / 申込者一括作成/更新 (upsert)
        • Count applicants / 申込者件数取得
        • Bulk update applicant status / 申込ステータス一括更新
      • Members
        • List members / メンバー一覧取得
        • Bulk create/update members / メンバー一括作成/更新
        • Get member custom field definitions / メンバーカスタムフィールド定義取得
        • Get member by ID / メンバー詳細取得
        • Update member / メンバー情報更新
        • Delete member / メンバー削除
        • Update member password / メンバーパスワード更新
      • Teams
        • List teams / チーム一覧取得
        • Bulk create/update teams / チーム一括作成/更新
        • Get team custom field definitions / チームカスタムフィールド定義取得
        • Get team by ID / チーム詳細取得
        • Update team / チーム情報更新
        • Delete team / チーム削除
    • API v1
      • Get member groups
        GET
    • Schemas
      • Schemas
        • ContactForm
        • Exam
        • ExamResult
        • Lesson
        • LessonAttempt
        • Notification
        • Settings
        • StaticFieldsSetting
        • TeamMember
        • TrainingQuestionnaireResponse
        • TrainingQuestionnaireTemplate
        • TrainingRegTemplate
        • TrainingTaskResponse
        • TrainingTaskTemplate
        • UnsubscriptionQuestionnaire
      • Training
      • Member
      • Team
      • TrainingApplication
      • CustomFieldMaster
      • CustomFieldData
      • ErrorResponse
      • SuccessResponse
      • ValidationErrorResponse

    イントロダクション

    REST APIについて#

    REST APIは、manaableのUIを使用せずにmanaableデータにアクセスするためのインターフェースを提供します。このREST APIを利用することで、manaableを自由にアプリケーションに統合することができます。必要なのは、このドキュメント内で対象情報(リソース)を見つけ、実行したい操作(検索、作成、更新など)を選び、manaableのエンドポイントにHTTPリクエストを送信するだけです。

    URI#

    URIは、manaable内のリソースを識別するパスです。URIの基本構造は以下の通りです(例外あり):
    https://[my-domain-name].manaable.com/api/v[X]/[resource]/
    [my-domain-name]は、manaable UIのサブドメインに置き換えてください。
    [X]は、使用するAPIのバージョンに置き換えてください。
    [resource]は、リソース名と残りのパスに置き換えてください。

    HTTPメソッド#

    REST APIは、標準的なすべてのHTTPリクエストメソッド(GET、POST、PATCH、PUT、DELETE)をサポートしています。ただし、すべてのリソースがすべてのメソッドに対応しているとは限らないことに注意してください。

    HTTPヘッダー#

    api-key - これは、manaableの管理サイトから取得できるAPIキーで、リクエストの認証に使用されます。
    Modified at 2024-06-06 15:00:52
    Previous
    Introduction
    Next
    API v3
    Built with