CAREKARTEログイン認証API

CAREKARTEで職員に設定されたIDとパスワードで、ログインの認証ができるAPIです。

認証に成功した場合、トークンを取得した事業所における、ログイン職員の有効な所属履歴が返却されます。
【有効な所属履歴】
所属履歴の開始日≦リクエスト日時≦所属履歴の終了日

以下の場合は、「EL401000 ログインに失敗しました。」が返却されます。
・ログインID又はパスワードが間違っている
・トークンを取得した事業所の有効な所属履歴が存在しない
・退職等で使用しないチェックが入っている

API ID

L0003

Request URL

ck/login
環境 URL
Staging環境 https://stage-api.link.carekarte.jp/ck/login
環境 URL
本番環境 https://api.link.carekarte.jp/ck/login

HTTPメソッド

POST

リクエスト

ヘッダー

名前 必須
Content-Type application/json
authorization tokenサービスで取得した値を設定

ボディ

パラメータ 必須 説明
loginId String 職員のログインID
password String 職員のパスワード

ログインを認証するサンプルデータ (実際にリクエストしても使用できません)

/ck/loginをリクエスト

URL:/ck/login

HTTPメソッド:POST

header:
Authorization:Bearer eyJhbGc…
Content-Type:application/json

body:
{
"loginId":"link",
"password":"link"
}

レスポンス

ボディ

パラメータ名 物理パラメータ名 配列内パラメータ 文字桁数 備考
職員ID staffId   Number 10  
family   String    
given   String    
姓フリガナ kanafamily   String    
名フリガナ kanagiven   String    
所属(APIキーの事業所のみ) belong   array   トークンをリクエストした事業所の所属情報
事業所コード   officeCd String 2  
事業所名   officeNm String    
ブロックコード   blockCd String 2  
ブロック名   blockNm String    
ユニットコード   unitCd String 3  
ユニット名   unitNm String    

ログイン認証成功時のサンプルデータ

{
    "staffId": "1111111121",
    "family": "LINK",
    "given": "職員",
    "kanafamily": "リンク",
    "kanagiven": "ショクイン",
    "belong": [
        {
            //連携イメージの所属履歴①
            "officeCd": "01",
            "officeNm": "【linktest】特別養護老人ホーム 新富士園",
            "blockCd": "01",
            "blockNm": "特養1F",
            "unitCd": "001",
            "unitNm": "特養ユニット1-1"
        },
        {
            //連携イメージの所属履歴②
            "officeCd": "01",
            "officeNm": "【linktest】特別養護老人ホーム 新富士園",
            "blockCd": "01",
            "blockNm": "特養1F",
            "unitCd": "002",
            "unitNm": "特養ユニット1-2"
        }
    ]
}

エラーレスポンス

エラーレスポンスを参照してください。

連携イメージ(CAREKARTE)

ログインIDとパスワードでリクエストすると、トークンを取得した事業所における、ログイン職員の有効な所属情報を返却します。