メインコンテンツまでスキップ

KREISEL APIについて

概要​

KREISEL は、外部のシステムから KREISEL の多様な機能をご利用いただくための、API（Application Programming Interface）をご用意しています。 この API を活用することで、KREISEL 単体では実現が難しい、お客様独自の要件に応じた柔軟なシステム連携が可能になります。

APIを利用するメリット​

  • 開発コストの削減: KREISEL が提供する豊富な機能を新たに開発することなく、お客様のシステムに組み込めます。
  • 柔軟なシステム連携: お客様の既存システムや、他の SaaS、Web アプリケーションと KREISEL をシームレスに連携させ、業務効率を大幅に向上させます。
  • 最新機能への追随: KREISEL API は継続的に開発が行われており、今後もさらに便利な機能が追加される予定です。
ご意見・ご要望について

API の機能改善や追加機能のご要望は、貴重な情報源として開発の参考にさせていただいております。 「こういう機能が欲しい」「この API が使いにくい」といったご意見がございましたら、お気軽にカスタマーサポートまでお寄せください。

APIの基本仕様​

API をご利用いただく上での基本的な仕様は以下の通りです。

  • SSL通信: API リクエストは、全て SSL/TLS（HTTPS）での通信が必須です。
  • フォーマット: リクエスト、レスポンスともに JSON 形式でデータを交換します。
  • 文字コードと改行コード: 送信する文字列はUTF-8、改行コードはLFに統一してください。
  • HTTPメソッド: POST のみに対応しています。
  • エンドポイント: API 名は URL のパスで指定します。
  • 制御文字: 改行コード・水平タブ以外のいわゆる制御文字は送信しないでください。
  • 機種依存文字・半角カナ:
    • 全ての機能において機種依存文字は受け付けません。
    • 原則として半角カナは受け付けませんが、do_member_form_action および validate_member_form_parameter のみ、フォーム側の設定に応じて半角カナを受け付けることができます。
OpenAPI 仕様

このドキュメントで解説する API は、OpenAPI 仕様に基づいています。詳細な定義はKREISEL API 仕様書でご確認いただけます。