こんにちわ!矢作です!

先日、「ワークフローと相性抜群!?APIとは?」というタイトルの記事を書きましたが、今回も API(Application Programming Interface)に関することです。

APIがどのようなものなのか分かったら、次に取り組みたくなるのは、実際に使ってみることですよね。

今回は、API を手軽に体験・検証するための方法を紹介します。APIとは何なのかについて理解したい人は、こちらの記事を先にご覧ください。

1 API体験に必要なものは?

今回紹介するAPI体験では、Web API というものを体験していただきます。Web API は Google Workspace や Salesforce などのクラウドサービスが公開している API で、Webブラウザでホームページを見るときと同じ HTTP (と呼ばれる通信規約)を使ってアクセスします。また、Web API にアクセスする方式には REST という方式を利用します。(RESTが何なのか?はあまり気にしなくて大丈夫です)

Web API を利用するには、インターネットに繋がるパソコンがあればそれでOKです。Windows で言うところのコマンドプロンプトや、Macで言うところの「ターミナル」を利用しますが、これがない場合には、Web ブラウザで利用する方法も紹介するので、ご安心ください。

ということで、インターネットに繋がる新鮮なパソコンをご用意ください!

2 経済産業省・内閣官房 の API を使おう!

今回利用する API は、RESAS(地域経済分析システム)という、地方創生の様々な取り組みを情報面から支援するために、経済産業省と内閣官房(まち・ひと・しごと創生本部事務局)が提供するシステムのAPIです。

RESAS 概要

RESAS の API は、申し込み手続きをするだけで無料で利用できること、REST 方式の Web API であること、アクセスするとそれなりに面白いデータが返ってくること、から、最初に体験するには丁度いいと考えました。

ということで、まずは RESAS の API を利用するために手続きから始めます。それほどややこしくなくて、以下の手順で手続きを進めます。

  • RESAS-API にアクセスする。
  • 画面右上の「RESAS−API利用登録・ログイン」をクリック。
  • 表示された画面のログインボタンの下にある「RESAS-API 利用新規登録」をクリック。
  • 次の画面でメールアドレスや氏名などを入力し、「入力内容確認」をクリック。
  • 次の画面で内容を確認して「上記内容で仮登録する」をクリック。

この後、「【本登録を完了させてください】利用登録仮完了のご案内」という件名のメールが届きます。そのメールに記載されたURLをクリックすると次のような画面が表示されて本登録が完了します。

RESAS-API利用登録完了画面

この図に書かれている API キーがとても重要ですので、すぐに画面を閉じてしまわずに、コピーしてどこかに保存しておいてください。(exampleEXAMPLEexample…の部分)

API はインターネット上に公開されているので、そのアクセス方法さえ知っていれば、誰でもアクセスできます。良いユーザだけでなく、悪意を持ったユーザが大きなデータを取得するリクエストを大量に送りつけてくる、というようなことも簡単にできてしまいます。そのため、事前にメールアドレスや氏名の登録と引き換えに、APIキーを持っている人からのアクセスだけ許す、というような仕組みが構築されています。

これで RESAS-API の利用準備は完了です。

ちなみに、RESAS-API にアクセスすると、RESAS(地域経済分析システム)に掲載されているデータを取得できます。都道府県一覧、市町村一覧などの比較的簡単なデータから、将来人口の推計や海外への企業進出動向など、様々なデータを取得可能です。

どのようなデータを取得できるのか?また、どのような方法で取得できるのか?については、RESAS-API仕様書をご覧ください。

3 API 仕様書を見てみよう

RESAS-API仕様書の左メニューにある RESAS-API一覧を見ると、様々なデータを取得できそうなことが分かると思います。

一番上の、都道府県一覧をクリックしましょう。

すると、都道府県一覧を取得するための方法が詳しく書かれています。一番上にある、GET api/v1/prefectures という部分は、GET メソッドで api/v1/prefectures というポイントにアクセスすると、都道府県一覧を取得できるよ、ということを伝えてくれています。

今回、次の parameters は不要なため説明を省略します。

都道府県一覧を取得するAPI(RESAS-API)

続いて responses です。API は、こちらからリクエストを送信すると、レスポンスと呼ばれるデータを返してくれます。そのデータの構成を示すものが、responses の表です。

この表は、/result/prefCode は都道府県コードを、/result/prefName は都道府県名を表すことを示しています。

最後の sample は、実際に API のエンドポイントにアクセスすると、どうなるのか?が示されています。sample の部分を見ると、

GET https://opendata.resas-portal.go.jp/api/v1/prefectures

の後に、次のような、なんだかムズカシそうな文字がつらつらと書かれています。

{
    "message": null,
    "result": [{
        "prefCode": 1,
        "prefName": "北海道"
    }, {
        "prefCode": 2,
        "prefName": "青森県"
    }, {
        "prefCode": 3,
…
…

ここは、API にアクセスする具体的な方法と、アクセス後に返されるレスポンスが書かれています。

GET https://opendata.resas-portal.go.jp/api/v1/prefectures

は、GET という方法で https://opendata.resas-portal.go.jp/api/v1/prefectures にアクセスすると、{ “message”: null, …というレスポンスが返ってくる、ことが示されています。

4 APIをつっつく(APIにアクセスする)

それでは、早速APIをつついてみましょう。何が出てくるか楽しみですね。

APIをつっつく(APIにアクセス)する方法として、本記事ではコマンドラインを利用するものと、ワークフローを利用する方法を紹介します。

API をつっつくには、RESAS-API の利用登録を完了した時に入手した API キーが必要です。

4-1 コマンドラインでAPIをつっつく

まずは Windows のコマンドプロンプトや、Mac のターミナルを使って、API にアクセスしてみましょう。

コマンドラインを入力することができる、Windows なら “コマンドプロンプト” 、Mac なら “ターミナル” を立ち上げてください。

立ち上がったら、次の文字を入力してください。

curl -H "X-API-KEY: (APIキー)" https://opendata.resas-portal.go.jp/api/v1/prefectures

コマンドラインで都道府県一覧を取得する様子(Windows コマンドプロンプト)

その後、Enter キーを押すことで、API に都道府県一覧データのリクエストを送ることになります。

では、Enter キーを押してみましょう。すると、次のような結果が返ってきます。

{"message":null,"result":[{"prefCode":1,"prefName":"北海道"},{"prefCode":2,"prefName":"青森県"},{"prefCode":3,"prefName":"岩手県"},{"prefCode":4,"prefName":"宮城県"},{"prefCode":5,"prefName":"秋田県"},{"prefCode":6,"prefName":"山形県"},{"prefCode":7,"prefName":"福島県"},{"prefCode":8,"prefName":"茨城県"},{"prefCode":9,"prefName":"栃木県"},{"prefCode":10,"prefName":"群馬県"},{"prefCode":11,"prefName":"埼玉県"},{"prefCode":12,"prefName":"千葉県"},{"prefCode":13,"prefName":"東京都"},{"prefCode":14,"prefName":"神奈川県"},{"prefCode":15,"prefName":"新潟県"},{"prefCode":16,"prefName":"富山県"},{"prefCode":17,"prefName":"石川県"},{"prefCode":18,"prefName":"福井県"},{"prefCode":19,"prefName":"山梨県"},{"prefCode":20,"prefName":"長野県"},{"prefCode":21,"prefName":"岐阜県"},{"prefCode":22,"prefName":"静岡県"},{"prefCode":23,"prefName":"愛知県"},{"prefCode":24,"prefName":"三重県"},{"prefCode":25,"prefName":"滋賀県"},{"prefCode":26,"prefName":"京都府"},{"prefCode":27,"prefName":"大阪府"},{"prefCode":28,"prefName":"兵庫県"},{"prefCode":29,"prefName":"奈良県"},{"prefCode":30,"prefName":"和歌山県"},{"prefCode":31,"prefName":"鳥取県"},{"prefCode":32,"prefName":"島根県"},{"prefCode":33,"prefName":"岡山県"},{"prefCode":34,"prefName":"広島県"},{"prefCode":35,"prefName":"山口県"},{"prefCode":36,"prefName":"徳島県"},{"prefCode":37,"prefName":"香川県"},{"prefCode":38,"prefName":"愛媛県"},{"prefCode":39,"prefName":"高知県"},{"prefCode":40,"prefName":"福岡県"},{"prefCode":41,"prefName":"佐賀県"},{"prefCode":42,"prefName":"長崎県"},{"prefCode":43,"prefName":"熊本県"},{"prefCode":44,"prefName":"大分県"},{"prefCode":45,"prefName":"宮崎県"},{"prefCode":46,"prefName":"鹿児島県"},{"prefCode":47,"prefName":"沖縄県"}]}

ちょっとびっくりするかも知れませんが、これが都道府県一覧データです。よーく見てみると、"{prefCode":1,"prefName":"北海道"}となっているところがありますね。この場合、都道府県コード=1、都道府県名=北海道、を表します。このような組み合わせが47都道府県分含まれています。

47都道府県について、都道府県コードと都道府県名の組み合わせ(都道府県一覧)を得ることができました。

4-2 ワークフローからAPIをつっつく

次に、ワークフロー(システム)からAPIにアクセスする方法を紹介します。

60日間無料でご利用いただける「Questetra BPM Suite」というクラウド型ワークフローを利用します。紹介する方法で、APIへのアクセスを試してみたい方は、次のページから是非お申し込みください。

ワークフローから API にアクセスするとはどういうことなのでしょうか?ワークフローシステムは、ワークフロー図通りに仕事を進めていくための仕組みです。

  • サポートチームが製品に関する問い合わせを受け付けて、メンバが回答案を作成する
  • サポートチームのリーダが回答案をレビューしOKを出す
  • メンバが回答を送信する

というように、誰が、何をするのか、が定められたものをワークフローと呼びます。ワークフローシステムを利用することで、ペーパーレス化が実現されるのはもちろんですが、業務の標準化・見える化が推進され、その結果、業務の品質及び効率が向上することが期待されます。

今回、APIへのアクセスは次のようなワークフローで実現されます。

  1. 人がGOサインを出す
  2. ワークフローシステムから、API にリクエストが送信される。
  3. ワークフローシステムはレスポンスを受信する

この簡単なフローをワークフロー図に描き、ワークフローシステムで稼働させます。

クラウド型ワークフロー「Questetra BPM Suite」にログインし、次のようなワークフロー図を作成しましょう。次に、APIからのレスポンスが格納されるデータ項目を用意します。ここではデータ項目の名称を「response」とします。

ワークフロー図とデータ項目の設定

HTTPという文字が書かれた丸いアイテムがあります。これが、API にリクエストを送信、レスポンスを受け取る部分です。このアイテムの中で、API仕様書に書かれている通りの設定を行います。

ワークフローからAPIにリクエストを送る設定

設定画面の「アクセスURL」に https://opendata.resas-portal.go.jp/api/v1/prefectures を入力します。同じ画面上の「レスポンスを保存するデータ項目」というところで、先ほど追加したデータ項目「response」を選びます。

続けて、この設定画面の中ほどにある「ヘッダ」をクリックします。ここでは API キーを設定します。ヘッダ名に「X-API-KEY」を、ヘッダの値に API キーを入力します。

ここまでできれば準備は完了です。デバッグモードを利用して、動作を確認しましょう。

  • 人がGOサインを出す
  • ワークフローシステムから、API にリクエストが送信される。
  • ワークフローシステムはレスポンスを受信する

この流れで処理が進みますが、GOサインを出すところでは、ボタンを押すだけです。

ワークフローからAPIにリクエストを送信

このフローの詳細を確認する画面で response というデータ項目の箇所を見ると、コマンドプロンプトで試したときとおなじように、​​{"message":null,"result":[{"prefCode":1,"prefName":"北海道"},{... というデータが表示されています。

このように、ワークフローの HTTP 通信を行う機能を活用することで、簡単に API へのリクエストを実現することができます。

また、ワークフローではAPIから受け取ったレスポンスを業務データに使うこともできます。

例えば、問い合わせ対応のワークフローを考えます。問い合わせが入ってくると同時に、Google スプレッドシートの API にリクエストを送信し、問い合わせ履歴シートからデータを取得する、というような事を実現できます。今回の問い合わせ者が、過去にどのような問い合わせをしたことがあるのかを確認しつつ、回答案を検討することができるようになりますね。

まとめ

APIがどのようなものであるのかを知っている人でも、実際にAPIを体験したことがある人は少ないのではないでしょうか?

実際にAPIを体験してみることで、今後の業務改善やビジネス展開のアイデアが出てくるかも知れません。コマンドプロンプトを利用する方法でも、クラウドワークフローを利用する方法でもどちらでも良いので、是非、これをキッカケに API を体験してみてください。

今回はここまで!

コメントを残す

このサイトはスパムを低減するために Akismet を使っています。コメントデータの処理方法の詳細はこちらをご覧ください

Scroll to Top
%d人のブロガーが「いいね」をつけました。