ホーム > スタートガイド

スタートガイド

初めて奉行クラウド API を利用する開発者の方向けのスタートガイドです。
アプリケーション開発環境の構築から、奉行クラウド API を実行するまでのフローです。

  • API のリファレンスは「APIs」をご参照ください。

  • API の共通仕様やセキュリティなど、アプリケーション開発時に必要な情報は「ドキュメント」をご参照ください。

奉行クラウド Connect Partner のご契約後に取得できる、『奉行クラウド』の「登録番号」「ライセンスキー」を使用して、アプリケーション開発環境を構築します。

  1. Web ブラウザを起動し、「https://id-demo.obc.jp/apply」 に接続します。

  2. 「はじめて『奉行クラウド』をご利用になるお客様」の[進む]ボタンをクリックします。
    続いて、[新しく環境を構築する]ボタンをクリックします。

  3. メールアドレスを入力し、[送信]ボタンをクリックします。

  4. 件名「【OBCiD】サービス利用情報を登録してください」というメールが届きます。
    メールに記載されている URL に接続します。

  5. 法人情報、ライセンス情報を入力します。
    確認して[次へ]ボタンをクリックします。

  6. サービス利用情報を確認し、[実行]ボタンをクリックします。

  7. 環境構築が完了すると、件名「【OBCiD】導入処理をはじめてください」というメールが届きます。
    メールには、以下の重要な項目を記載しています。

    • OBCiD

    • パスワード

    • ダウンロード URL

  8. ダウンロード URL をクリックし、メールに記載されているOBCiDとパスワードを入力して『奉行クラウド』にログインします。

  9. 画面の手順にしたがって『奉行クラウド』をダウンロードし、セットアップします。

『管理ポータル』でアクセストークンを発行します。

  1. 『管理ポータル』へログインし、[連携アプリケーション]メニューを選択します。

  2. [アクセストークンの発行]ボタンをクリックします。

  3. 連携アプリケーション名を入力し、[登録]ボタンをクリックします。

  4. [発行する]ボタンをクリックし、アクセストークンを発行すると、画面上にアクセストークンが表示されます。

    アクセストークン:***********************************************

    [情報のコピー]ボタンをクリックすると、クリップボードにコピーできます。
    発行したアクセストークンを API のリクエストヘッダーに設定することで、奉行クラウド API を実行できます。

参考
OAuth2.0 認可コードフローでアクセストークンを取得する場合は「認証・認可」をご参照ください。

API のリクエストヘッダーに「テナントID」を指定することで、API の実行先の『奉行クラウド』の法人が決まります。
「テナント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": ""
},
{
...
}
]

API のリクエストヘッダーに以下の値を指定することで、奉行クラウド API を実行できます。

  • Authorizationヘッダー:アクセストークン(3 の手順で取得)

  • X-OBC-TenantIDヘッダー:テナントID(4 の手順で取得)

実行する API は、 API のリファレンス「APIs」をご参照ください。