マネーフォワードクラウド請求書APIへのアクセスをテストしてみよう!


みなさん、こんにちは!
タカハシ(@ntakahashi0505)です。

マネーフォワードクラウド請求書APIの使い方についてできる限りていねいに紹介をするシリーズをお送りしています。

前回の記事はこちら。

はじめてのマネーフォワードクラウド請求書API~その概要とおおまかな手順
本シリーズは、マネーフォワードクラウド請求書APIの使い方についてできる限りていねいに紹介をしていきます。今回は、はじめてのマネーフォワードクラウド請求書APIについての概要とおおまかな手順について解説をしていきます。

マネーフォワードクラウド請求書APIの概要とそのおおまかな手順についてお伝えしました。

ただ、「おおまかな手順」とは言いつつも、かなり難しい印象を持たれた方は多いハズ…!

今回はマネーフォワードクラウド請求書APIのテスト用のページを用いてじっくり理解を深めていきましょう。

ということで、マネーフォワードクラウド請求書APIへのアクセスをテストしてみよう!をお送りします。

では、行ってみましょう!

スポンサーリンク

マネーフォワードクラウド請求書APIを使う手順

まず、マネーフォワードクラウド請求書APIを使う手順をざっとおさらいしておきましょう。

手順は以下のとおりです。

  1. マネーフォワードクラウド請求書API用のアプリケーションの作成
  2. 認証とアクセストークンの発行
  3. マネーフォワードクラウド請求書APIにリクエスト

実は、以下マネーフォワードクラウド請求書APIのドキュメントページで、APIへのアクセスのテストができますので、まずは上記手順に則って試しきます。お付き合いください。

https://invoice.moneyforward.com/api/v2/swagger_ui

マネーフォワードクラウド請求書のアプリケーションを作成

まず、マネーフォワードクラウド請求書に「アプリケーション」を作ります。

アプリケーションとはなんぞや…という感じですが、マネーフォワードクラウド請求書の画面から作れますので、ひとまず作ってみましょう。

マネーフォワードクラウド請求書にログインし、右上の「歯車」アイコンから「API連携β(開発者向け)」を選択します。

マネーフォワードクラウド請求書API連携を選択

続く画面で「新規作成」をクリックします。

ここで、「スタートアップガイド」や「v2 ドキュメント」などは後ほど使いますので、チェックしておきましょう。

マネーフォワードクラウド請求書APIのアプリケーション新規作成

「新規アプリケーション登録」の画面で以下入力の上、利用規約にチェックをして「作成」をクリックします。

  • 名前: アプリケーション名(ひとまず「サンプルアプリケーション」などでOK)
  • Redurect URI: https://invoice.moneyforward.com/api/swagger_ui/oauth2_redirect(APIドキュメントページで指示されているとおり)
  • Scopes: write

マネーフォワードクラウド請求書APIの新規アプリケーション登録

これで、アプリケーションの作成が完了しました。

マネーフォワードクラウド請求書APIのアプリケーションが作成された

ここで、Client IDとClient Secretというコードが新たに発行されます。

後ほど認証の段階で使用しますので、メモしておきましょう!

認証とアクセストークンの発行

では、続いて認証とアクセストークンの発行の手順を行ってみましょう。

以下ページから認証とアクセストークンの発行のテストが行えますので開きましょう。

https://invoice.moneyforward.com/api/v2/swagger_ui

画面を開いて、ざっと文章を読んでみてください。

ちょっと難しいかも知れませんが、ここがマネーフォワードクラウド請求書APIのドキュメントで、APIによる操作のテストも行えます。

右のほうに「Authorize」というボタンがありますので、クリックしてみましょう。

マネーフォワードクラウド請求書APIのAuthorize

すると、以下のように「Available authorizations」というダイアログが開きます。

client_idとclient_secretは先ほどアプリケーション作成時にゲットしたものを入力します。

また、Scopesは「write」としていましたので、そちらをチェック→そして「Authorize」をクリックします。

マネーフォワードクラウド請求書APIのavailable authorizations

これは何をしているかというと、先ほど作成したアプリケーションを通じて、マネーフォワードクラウド請求書にアクセスしてよいかどうかの認証をしようとしているわけです。

すると、以下のようにマネーフォワードクラウド請求書の「アプリケーションの承認」という画面が表示されますので、「許可」をクリックします。

マネーフォワードクラウド請求書APIのアプリケーションの承認

これにて、アプリケーションの認証が完了しまして、以下の画面が表示されます。

マネーフォワードクラウド請求書APIで認証が完了

「Close」で画面を閉じてOKです。

マネーフォワードクラウド請求書APIへのアクセスをテスト

では、これにてマネーフォワードクラウド請求書へのアクセスの認証が完了しましたのでテストをしてみましょう。

このページでテストを行うことができますので、「事業者情報の取得」について「Try it out」をクリックしてみましょう。

マネーフォワードクラウド請求書APIでTry it out

「Execute」というボタンが登場するので、クリックします。

マネーフォワードクラウド請求書APIでExcecute

すると、以下のようにCurl、Request URL、Server responseが表示されます。

Server responseの中には、事業者情報が表示されていることが確認できますね。

マネーフォワードクラウド請求書APIのレスポンス

「Curl」の欄ですが、どのようなリクエストを送ったかというのが、Curlコマンド形式で把握できます。

ここで重要なのは、「Authorization: Bearer 」の次に表示されている文字列で、これはアクセストークンというものです。

実は先ほど「認証」の作業を行ったときに、このアクセストークンも発行されていました。

このアクセストークンは30日間有効になるもので、マネーフォワードクラウド請求書へのアクセスの許可証のような役割を果たします。

curlコマンドでAPIへのアクセスをテストする

Curlコマンドですが、実際に実行しても同様の結果が返ってくるか確認してみましょう。

curl -X GET “https://invoice.moneyforward.com/api/v2/office” -H “accept: application/json” -H “Authorization: Bearer 8318*************”

すると、以下のように無事に事業所の情報が取得できていることがわかります。

curlコマンドでマネーフォワードクラウド請求書APIにリクエスト

ここで、以下のような設定でコマンド実行していることを確認しておきましょう。

  • Method: GET
  • URL: “https://invoice.moneyforward.com/api/v2/office”
  • ヘッダー
    • accept: application/json
    • Authorization: Bearer 8318*************”

ここで、curlコマンドの内容をある程度把握しておくと、後々GASを使用した場合の理解の助けになります。

まとめ

以上、マネーフォワードクラウド請求書APIへのアクセスをテストしてみよう!をお送りしました。

次回は、GASでマネーフォワードクラウド請求書APIを操作していきます。

GAS用のマネーフォワードクラウド請求書APIアプリケーションを作成する手順
マネーフォワードクラウド請求書APIの使い方についてできる限りていねいに紹介をするシリーズをお送りしています。今回は、GAS用のマネーフォワードクラウド請求書APIアプリケーションを作成する手順をお伝えします。

どうぞお楽しみに!

連載目次:【初心者向け】GASでマネーフォワード請求書API

マネーフォワード請求書APIを使用することで、GASからマネーフォワード請求書のデータを取得したり、操作をしたりすることが可能です。このシリーズでは、そのはじめの一歩として、マネーフォワード請求書APIとは何か?またGASによるアクセスの初歩をお伝えしていきます!
  1. はじめてのマネーフォワード請求書API~その概要とおおまかな手順
  2. マネーフォワード請求書APIへのアクセスをテストしてみよう!
  3. GAS用のマネーフォワード請求書APIアプリケーションを作成する手順
  4. GASでAPIを操作をする強い味方「OAuth2 for Apps Script」ライブラリとその導入
  5. GASでマネーフォワードクラウド請求書APIへの認証とアクセストークンの取得を行う方法
  6. OAuth2 for Apps Scriptライブラリを使ってサービスを作るスクリプトを解説
  7. OAuth2 for Apps Scriptライブラリはどうやって認証用URLを作成しているのか
  8. OAuth2 for Apps Scriptライブラリはどうやってアクセストークンを取得するのか
  9. GASではじめてのマネーフォワードクラウド請求書APIへリクエスト
  10. マネーフォワードクラウド請求書APIから請求書一覧の取得をテストしてみよう!
  11. マネーフォワードクラウド請求書APIによる請求書一覧のデータを読み取ってみよう!
  12. GASでマネーフォワード請求書の請求書一覧を取得するスクリプト
  13. GASでマネーフォワードクラウド請求書の請求書一覧をスプレッドシートに書き出す方法
  14. マネーフォワードクラウド請求書の請求書一覧の全件をスプレッドシートに書き出すスクリプト

タイトルとURLをコピーしました