ロゴ：Bill One

本 Bill One API スタートガイドは機密情報であり、当社の事前の承諾なく第三者に開示することはできません。

Bill One API スタートガイド

ここでは「Bill One API」を呼び出すまでに必要な手順を記載しています。 この操作にはシステム管理(system)の権限が必要です。

大まかな流れ

  1. API ユーザーを発行する
  2. API アプリケーションを作成する
  3. アクセストークンとリフレッシュトークンを取得する
  4. Bill One API で請求書情報を取得してみる

1. API ユーザーを発行する

API ユーザーを発行し、メールアドレスとパスワードを取得します。

API ユーザーは API の利用を許可するために必要となる、特別なユーザーです。テナントごとに 1 つだけ発行でき、Bill One サービス自体へのログインはできません。

  1. 右上のメニューから [システム設定] - [Bill One API 設定] をクリック。
  2. [API ユーザーを発行] をクリック。
  3. メールアドレスとパスワードが発行されるので、お控えください。 また、パスワード は API の利用を許可するための秘密情報となりますので、他者に公開しないようご注意下さい。

2. API アプリケーションを作成する

API アプリケーションを追加し、client_idとclient_secretを取得します。

API アプリケーションとは Bill One API を利用する主体を指します。

  1. Bill One API 設定画面で [アプリケーションを追加] をクリック。
  2. API を利用するアプリケーション名及び必要な権限を入力して「保存」をクリック。 追加されるとclient_idが表示されます。
  3. client_secret 列の [取得] を選択すると、クリップボードに client_secret がコピーされます。

client_id と client_secret はリフレッシュトークンからアクセストークンを取得する場合に必要になります。

client_secret は API アプリケーションを特定するための秘密情報となりますので、他者に共有・公開しないようご注意ください。

3. アクセストークンとリフレッシュトークンを取得する

  1. リフレッシュトークン列の [認証ページ] をクリック。 認証用ログイン画面が開きます。
  2. 「1. API ユーザーを発行する」で控えておいたメールアドレス と パスワード でログイン。
  3. アクセストークン と リフレッシュトークン が表示されます。

アクセストークン と リフレッシュトークン は認証情報となりますので、他者に公開することがないよう大切に保管してください。 アクセストークン の有効期限は 24 時間で、リフレッシュトークン の有効期限はありません。

4. Bill One API で請求書情報を取得する

$ACCESS_TOKEN を「3. リフレッシュトークンを取得する」で控えた アクセストークン に置き換えて次のコマンドを実行すると、テナント内の請求書情報を取得できます。

curl -X GET "https://api.bill-one.com/v1/invoices" -H "accept: application/json" -H "authorization: Bearer $ACCESS_TOKEN"

レスポンスの例

[
  {
    "invoiceUUID": "1f89b681-04b9-4a15-b722-c93f4d0cbcd2",
    "invoiceURL": "https://example.app.bill-one.com/recipient/invoice/e1fdd3bc-86eb-413d-8fc6-1e30f08e0389",
    "pdfURL": "https://api.bill-one.com/v1/invoices/1f89b681-04b9-4a15-b722-c93f4d0cbcd2/pdf",
    "billOneNumber": 42,
    "recipient": {
      "recipientUUID": "70bd4391-4f01-4576-ac39-567e1e16256d",
      "email": "yamada@example.com",
      "fullName": "山田太郎"
    },
    "registeredAt": "2021-02-03T04:01:17.294Z",
    "invoiceType": "DOMESTIC",
    "paymentMethod": "BANK_TRANSFER",
    "invoiceAmount": "49800",
    "paymentDeadline": "2021-02-28",
    "supplierOrganizationName": "発行物産株式会社",
    "supplierFullName": "佐藤花子",
    "registerChannel": "SENDER_UPLOAD",
    "opened": true,
    "forwarded": true,
    "deleted": false,
    "digitized": true,
    "extensionFields": [
      {
        "key": "extensionField1",
        "value": "PO00034",
        "label": "注文番号"
      }
    ]
  }
]

認証について