ホーム > ドキュメント > テナント・サービス

テナント・サービス

テナント

奉行クラウド API を利用するためには、接続する『奉行クラウド』の法人（テナント）を指定する必要があります。
『奉行クラウド』は複数法人の管理をすることができるため、『奉行クラウド』に接続するアプリケーションはどの法人に接続するか指定し、API を実行します。

参考
『合算データ for 総務人事奉行V ERPクラウド Group Management Model』のライセンスで作成した「合算データの法人」に対して API は利用できません。

テナントの取得

奉行クラウド API では、アクセスする法人を特定するために、リクエストヘッダーの「X-OBC-TenantID」に「テナントID」を指定する必要があります。
お客様が『奉行クラウド』のライセンスを利用して運用環境を構築した際に、システムによって割り当てられる「テナントID」は、 SearchTenant API を実行して取得します。

Response Body（単一法人）

[
    { 
        "id": "*****************************", 
　     "code": "ABCDE01234", 
　     "name": "OBC商事株式会社", 
　     "nameKana": "OBCショウジカブシキガイシャ", 
　     "memo": "OBC商事株式会社の法人データです。"
    }, 
]

Response Body（複数法人）

[
    {
        "id": "*****************************", 
　     "code": "ABCDE01234", 
　     "name": "OBC商事株式会社", 
　     "nameKana": "OBCショウジカブシキガイシャ", 
　     "memo": "OBC商事株式会社の法人データです。" 
     }, 
     { 
        "id": "*****************************", 
　     "code": "", 
     　"name": "OBC物産株式会社", 
　     "nameKana": "OBCブッサンカブシキガイシャ", 
　     "memo": ""
    },
    { 
        ... 
    }
]

テナントの選択

お客様が複数の法人を使用している場合、SearchTenant API では複数の法人情報を取得できます。
取得した法人のうち１社に接続する場合は、お客様が接続する法人を選択する「法人選択画面」をアプリケーションに用意する必要があります。
アプリケーションの特性にあわせて、複数の法人でもご利用いただける仕組みをご用意ください。

SearchTenant API で取得できる法人情報には、API を実行できない法人情報も含まれます。
API を利用できない法人の ID を指定して API を実行した場合、以下のエラーレスポンスが返却されます。

404 Not Found 
{ 
    "message": "指定した接続先に、有効なライセンスがありません。" 
}

サービス

奉行クラウド API では、お客様が管理している法人に紐づくサービスの API を利用することができます。
例えば、お客様が１つの法人で『勘定奉行クラウド』をお使いの場合、ご利用できる API は『勘定奉行クラウド』の API だけとなります。

奉行クラウド API を利用できるサービス

勘定奉行クラウド
勘定奉行クラウド[個別原価管理編]
勘定奉行クラウド[建設業編]
固定資産奉行クラウド
債権奉行クラウド
債務奉行クラウド
商奉行クラウド
蔵奉行クラウド
奉行Edge 発行請求書DXクラウド
総務人事奉行クラウド
奉行Edge 労務管理電子化クラウド
給与奉行クラウド
奉行Edge 勤怠管理クラウド

テナントとサービスの関係

『奉行クラウド』では、お客様環境で複数法人の管理ができます。法人ごとにサービスは紐づくため、複数法人を管理している場合、法人ごとに利用できる奉行クラウド API が異なる場合があります。
アプリケーションの特性にあわせて、お客様が接続する法人を選択する「法人選択画面」をアプリケーションに用意する必要があります。

複数の法人を管理している場合

上記の場合、『給与奉行クラウド』の API を利用するには法人Aを選択する必要があります。

参考
法人Bを選択して『給与奉行クラウド』のAPIを利用した場合、以下のエラーレスポンスが返却されます。

404 Not Found
{
    "message" : "指定した接続先に、有効なライセンスがありません。"
}