API接続設定

■概要

請求管理ロボでAPIを接続するための設定について説明します。

 

■設定手順

①API接続に関しましては、オプションとなりますのでご利用希望の際はお手数ではございますが、
 下記問い合わせ先へご連絡頂きますようお願い致します。

 【請求管理ロボ サポートセンター】

  mail:support@billing-robo.jp

 

②請求管理ロボ画面のAPI接続設定を選択します

API接続設定_20230706_1.png

 

③「API接続編集」をクリックする

API接続設定.png

 

④アクセスキーを取得し、送信元IPを設定します
 ※送信元IPについては任意項目となります。
  指定する場合は「一部のIPを許可する」にチェックを入れてください。

 

⑤アクセスキーの発行が完了しましたら、API仕様書に基づきリクエストデータを送信すると
 APIが実行されます。
 API仕様書については、下記よりご確認ください。

 ▼API仕様書&シーケンス図
  https://keirinomikata.zendesk.com/hc/ja/articles/115000144622

 

<仕様>
■API接続設定
  API接続時の承認コード(アクセスキー)、送信元IPアドレスを設定することで
  意図しないユーザからのAPI実行を防ぎ、セキュリティを強化できます。
  ●承認コード
    API実行時に指定する承認コード(アクセスキー)を設定します。
    承認コードを変更する場合は、「再発行」ボタンを押下してください。
    承認コードを更新した場合、以前の承認コードを指定してAPIを実行すると
    エラーとなりますのでご注意ください。
  ●送信元IPアドレス
    送信元IPアドレスを制限する為に、送信元IPアドレスを設定します。
    - すべて許可する
     どのような送信元IPアドレスでもAPIアクセス可能な状態です。
    - 一部のIPを許可する
     接続許可IPに登録された送信元IPアドレスでのアクセスの場合にAPIアクセスを許可します。

  IPアドレスは単一または帯域で指定することができます。
  帯域指定は第3、4オクテットの範囲で指定してください。
  例)192.0.2.0~192.0.2.255

■API実行
  ●リクエストパラメータ
    user_id:API実行権限のあるユーザIDを指定してください。
    access_key:API接続設定で設定した承認コード(アクセスキー)を指定してください。
    その他のリクエストパラメータは、APIによって異なる為、API仕様書をご覧ください。
  ●アクセスキーエラー
    API接続設定で設定した承認コード(アクセスキー)とAPI実行時に指定した承認コード(アクセスキー)が異なる場合「12:アクセスキーが不正」が返却されます。
  ●IPアドレスエラー
    API接続設定に登録されている許可IP以外からAPI実行した場合「13:接続IPが不正」が返却されます。