メインコンテンツまでスキップ
API docs by Redocly

ukabisプラットフォーム基盤API (1.0.0)

Download OpenAPI specification:Download

ukabisプラットフォーム基盤API

このAPIは以下の特徴を持ちます：

  • システム基盤として提供される不変のAPI
  • 認証等を含む
  • すべてのukabis APIで共通利用される

利用開始までの流れ

  1. 管理画面でベンダーシステムを登録
  2. ユーザー招待を受けてアカウント作成
  3. 各認証でトークンを取得
  4. APIエンドポイントを呼び出し

認証

ukabisには、大きく分けて2つの認証が存在しています。

  • ベンダーシステム認証
    • 登録されたベンダーシステムごとの認証
  • OpenID認証
    • API呼び出しユーザーごとの認証

ベンダーシステム認証

管理画面（adminweb）上でベンダーシステムごとに払い出される認証情報を使用して、ukabis独自のトークンを払い出します。

Request Body schema: application/x-www-form-urlencoded
client_id
string
Default: ""

管理画面から発行される、クライアントID

client_secret
string
Default: ""

管理画面から任意の値で登録できる、クライアントシークレット

grant_type
string
Default: "client_credentials"

Responses

Request samples

Content type
application/x-www-form-urlencoded
client_id=03e17de6-4a5b-0159-3642-e9703c8222dc&client_secret=secretXXX0123%3F&grant_type=client_credentials

Response samples

Content type
application/json
{
  • "access_token": "eyJhbGciOiJodHRwOi8vd3d3LnczLm...hs1YlXb-Jw",
  • "token_type": "bearer",
  • "expires_in": 43200
}

OpenID認証

OCI上のドメインに対して、ユーザー個別のtokenを払い出します。

Request Body schema: application/x-www-form-urlencoded
client_id
string
Default: "4ff76c73770b42d3a786f2d7b4ceea4d"

ukabisアプリのクライアントID（共通）

client_secret
string
Default: "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"

ukabisアプリのクライアントシークレット（共通）

username
string
Default: ""

ユーザー招待を受けた際に登録したユーザー名（ユーザーID）

password
string
Default: ""

ユーザー招待を受けた際に登録したパスワード

grant_type
string
Default: "password"
scope
string
Default: "b3f3d469-e244-4ddd-8510-2a04e47be547123"

Responses

Request samples

Content type
application/x-www-form-urlencoded
client_id=5387f21b-43b9-cb93-9d1a-0d8d58d47dd9&client_secret=667b3e1977ae09799d8dfdff7fb7c822&username=user_001&password=Passw0rd&grant_type=password&scope=account

Response samples

Content type
application/json
{
  • "access_token": "eyJ4NXQjUzI1NiI6ImtUMjFZd0FOVDNldW1fLU1Edm...Ts_lI3zEnB7TMYd-c46iFMRX1AmoFTa6GFw",
  • "token_type": "Bearer",
  • "expires_in": 36000
}