221017 WinActorにおけるAPI連携 NTTアドバンステクノロジ

by comucal

Slide 1

Slide 1 text

Slide 2

Slide 2 text

Slide 3

Slide 3 text

Slide 4

Slide 4 text

© 2022 NTT Advanced Technology Corporation 4 Apprication Programming Interfaceの略称。あるサービスがアプリケーションのために準備した、サービスを利用できる窓口のようなものです。 ■そもそもAPIって何？ API連携とは？ APIを使う方法はいくつかありますが、今回はHTTPを利用したAPIについて説明します。 HTTPを利用したAPIは、特にREST APIと呼ばれます。 RESTとは設計思想の名称で、平たく言えば「リソースごとにURLをもつ設計」のことを指します。パソコン上のファイルパスと同じような構造と考えてみてください。 ■どうやって使うもの？

Slide 5

Slide 5 text

© 2022 NTT Advanced Technology Corporation 5 ■つまりAPI連携って何？ HTTPを使って、特定のサービス上のファイルや情報を読み込んだり、アップロードしたりして操作することと定義します。 WinActor的な表現で言えば、HTTPライブラリを利用したシナリオのことになります。 API連携とは？サービス API ユーザ情報 WinActorシナリオユーザ情報取得処理（HTTP）ユーザ登録処理（HTTP）新しいユーザ情報サービスの中のデータを、APIを通してファイルやフォルダのように操作できる

Slide 6

Slide 6 text

© 2022 NTT Advanced Technology Corporation 6 ■なぜAPI連携？ API連携を使う理由は、とにかくシナリオの動作が安定することに尽きます。サービスと連携する方法はいくつかありますが、API連携でシナリオを作成してしまえば、その後サービスの画面が更新されたり、バージョンアップしたりしてもシナリオを更新することなく使い続けることができます。 API連携の必要性

Slide 7

Slide 7 text

© 2022 NTT Advanced Technology Corporation 7 ■サービス連携の種類そもそも、WinActorで他のサービスと連携する方法はいくつか存在します。 API連携の必要性 ①画面操作による連携ブラウザ操作ライブラリでウェブページ上のボタンやフォームを操作する方法 ②ファイル操作による連携シナリオなどで作成したファイルを所定の場所に配置することで連携する方法 ③APIによる連携シナリオとサービスをHTTPで連携する方法ウェブページ C:¥XXXXXX ファイルシナリオファイルサービスシナリオサービス HTTP

Slide 8

Slide 8 text

© 2022 NTT Advanced Technology Corporation 8 ■①画面操作による連携画面操作による連携は、普段から利用している画面をシナリオで実現するので直感的にわかりやすく、また操作の記録機能などである程度自動でも作れるというお手軽さが魅力です。 API連携の必要性 ①画面操作による連携ブラウザ操作ライブラリでウェブページ上のボタンやフォームを操作する方法ウェブページ ■メリットわかりやすい！人間の操作を再現するだけでOK ■デメリット画面が新しくなると使えなくなることがある… ウェブページウェブページ２更新動かない

Slide 9

Slide 9 text

© 2022 NTT Advanced Technology Corporation 9 ■②ファイル操作による連携 BoxやGoogleDriveなど、主にファイル共有サービスなどで使われる連携方法です。WinActorシナリオとの親和性が高く、シナリオ化し易いです。 API連携の必要性 ②ファイル操作による連携シナリオなどで作成したファイルを所定の場所に配置することで連携する方法 C:¥XXXXXX ファイルシナリオファイルサービス ■メリットシナリオ化が簡単！ファイル操作は得意分野 ■デメリット利用できるサービスがかなり限定される…

Slide 10

Slide 10 text

© 2022 NTT Advanced Technology Corporation 10 ■③APIによる連携 API連携は、①②のような人間が操作するやり方を真似するのではなく、アプリケーションのためのやり方を実現することで連携するため、とにかく動作が安定します。 API連携の必要性 ③APIによる連携シナリオとサービスをHTTPで連携する方法シナリオサービス HTTP ■メリットとにかく安定！画面やバージョンが新しくなってもちゃんと動く ■デメリットちょっとむずかしい…

Slide 11

Slide 11 text

Slide 12

Slide 12 text

Slide 13

Slide 13 text

© 2022 NTT Advanced Technology Corporation 13 ■要求と応答を実践してみる ※すぐ呼び出し可能なWebAPIのサンプル https://www.umayadia.com/Note/Note028WebAPISample.htm ※シェイクスピアさんのユーザ情報アドレス https://umayadia-apisample.azurewebsites.net/api/persons/Shakespeare 今回はお試しということで、「すぐ呼び出し可能なWebAPIのサンプル」※を利用させていただきます。 HTTPライブラリのプロパティに、それぞれ以下の設定を行います。 HTTPライブラリ（2/2）「基本設定」タブの対象のURLを入力 ※例ではシェイクスピアさんを入力「応答」タブの「ボディ」タブ内にあるファイル名に、「応答.json」を入力

Slide 14

Slide 14 text

Slide 15

Slide 15 text

Slide 16

Slide 16 text

© 2022 NTT Advanced Technology Corporation 16 ■応答の内容は？「応答.json」をテキストエディタなどで開いてみると、次のような内容になっています。これは「JSON形式」と呼ばれるフォーマットです。APIの応答でよく使われる、アプリケーションが読みやすいように加工されたデータで、人間が読むにはちょっとわかりにくいです。上記の内容をわかりやすく書き換えるなら、「要求は成功しました。このデータに登録されている情報は次の通りです。名前はShakespeare、メモには Hamletと書いてあり、年齢は１３、登録日は1564年４月２６日の２０時２１分です。」となります。 JSONの概要（1/9） {"success":true,"data":{"name":"Shakespeare","note":"Hamlet","age ":13,"registerDate":"1564-04-26T20:21:00"}}

Slide 17

Slide 17 text

© 2022 NTT Advanced Technology Corporation 17 ■少しだけJSONの解説 JSON形式のデータを加工するにあたり、少しだけJSONの構造について解説します。 JSONの構造は、データの構造をまとめる「オブジェクト」と呼ばれるデータのかたまりと、データそのものを記録する「キー」「値」のセットをカンマ（,）でつないで組み合わせてつくりあげます。「オブジェクト」は{}で囲まれた部分のことを指し、「キー」「値」のセットは”キー”:”値”のように書かれた部分を指します。 JSONの概要（2/9） {"success":true,"data":{"name":"Shakespeare","note":"Hamlet","age ":13,"registerDate":"1564-04-26T20:21:00"}}

Slide 18

Slide 18 text

© 2022 NTT Advanced Technology Corporation 18 ■少しだけJSONの解説 JSON形式のデータを加工するにあたり、少しだけJSONの構造について解説します。 JSONの構造は、データの構造をまとめる「オブジェクト」と呼ばれるデータのかたまりと、データそのものを記録する「キー」「値」のセットをカンマ（,）でつないで組み合わせてつくりあげます。「オブジェクト」は{}で囲まれた部分のことを指し、「キー」「値」のセットは”キー”:”値”のように書かれた部分を指します。 JSONの概要（3/9） {"success":true,"data":{"name":"Shakespeare","note":"Hamlet","age ":13,"registerDate":"1564-04-26T20:21:00"}} 最初の｛と最後の｝で囲まれた、大きなオブジェクト。オブジェクトの中にはいくつかの「キー」「値」のセットがある。

Slide 19

Slide 19 text

© 2022 NTT Advanced Technology Corporation 19 ■少しだけJSONの解説 JSON形式のデータを加工するにあたり、少しだけJSONの構造について解説します。 JSONの構造は、データの構造をまとめる「オブジェクト」と呼ばれるデータのかたまりと、データそのものを記録する「キー」「値」のセットをカンマ（,）でつないで組み合わせてつくりあげます。「オブジェクト」は{}で囲まれた部分のことを指し、「キー」「値」のセットは”キー”:”値”のように書かれた部分を指します。 JSONの概要（4/9） {"success":true,"data":{"name":"Shakespeare","note":"Hamlet","age ":13,"registerDate":"1564-04-26T20:21:00"}} successというキーと、trueという値。このセットが１つのデータになる。また、数字や真偽値は””で囲まない。

Slide 20

Slide 20 text

© 2022 NTT Advanced Technology Corporation 20 ■少しだけJSONの解説 JSON形式のデータを加工するにあたり、少しだけJSONの構造について解説します。 JSONの構造は、データの構造をまとめる「オブジェクト」と呼ばれるデータのかたまりと、データそのものを記録する「キー」「値」のセットをカンマ（,）でつないで組み合わせてつくりあげます。「オブジェクト」は{}で囲まれた部分のことを指し、「キー」「値」のセットは”キー”:”値”のように書かれた部分を指します。 JSONの概要（5/9） {"success":true,"data":{"name":"Shakespeare","note":"Hamlet","age ":13,"registerDate":"1564-04-26T20:21:00"}} ｄataというキーと、{}で囲まれたオブジェクト。 dataというキーに対応する値は1つではなく、複数あることになる。

Slide 21

Slide 21 text

© 2022 NTT Advanced Technology Corporation 21 ■少しだけJSONの解説 JSON形式のデータを加工するにあたり、少しだけJSONの構造について解説します。 JSONの構造は、データの構造をまとめる「オブジェクト」と呼ばれるデータのかたまりと、データそのものを記録する「キー」「値」のセットをカンマ（,）でつないで組み合わせてつくりあげます。「オブジェクト」は{}で囲まれた部分のことを指し、「キー」「値」のセットは”キー”:”値”のように書かれた部分を指します。 JSONの概要（6/9） {"success":true,"data":{"name":"Shakespeare","note":"Hamlet","age ":13,"registerDate":"1564-04-26T20:21:00"}} nameというキーと、Shakespeare という値。

Slide 22

Slide 22 text

© 2022 NTT Advanced Technology Corporation 22 ■少しだけJSONの解説 JSON形式のデータを加工するにあたり、少しだけJSONの構造について解説します。 JSONの構造は、データの構造をまとめる「オブジェクト」と呼ばれるデータのかたまりと、データそのものを記録する「キー」「値」のセットをカンマ（,）でつないで組み合わせてつくりあげます。「オブジェクト」は{}で囲まれた部分のことを指し、「キー」「値」のセットは”キー”:”値”のように書かれた部分を指します。 JSONの概要（7/9） {"success":true,"data":{"name":"Shakespeare","note":"Hamlet","age ":13,"registerDate":"1564-04-26T20:21:00"}} noteというキーと、Hamletという値。

Slide 23

Slide 23 text

© 2022 NTT Advanced Technology Corporation 23 ■少しだけJSONの解説 JSON形式のデータを加工するにあたり、少しだけJSONの構造について解説します。 JSONの構造は、データの構造をまとめる「オブジェクト」と呼ばれるデータのかたまりと、データそのものを記録する「キー」「値」のセットをカンマ（,）でつないで組み合わせてつくりあげます。「オブジェクト」は{}で囲まれた部分のことを指し、「キー」「値」のセットは”キー”:”値”のように書かれた部分を指します。 JSONの概要（8/9） {"success":true,"data":{"name":"Shakespeare","note":"Hamlet","age ":13,"registerDate":"1564-04-26T20:21:00"}} ageというキーと、13という値。

Slide 24

Slide 24 text

© 2022 NTT Advanced Technology Corporation 24 ■少しだけJSONの解説 JSON形式のデータを加工するにあたり、少しだけJSONの構造について解説します。 JSONの構造は、データの構造をまとめる「オブジェクト」と呼ばれるデータのかたまりと、データそのものを記録する「キー」「値」のセットをカンマ（,）でつないで組み合わせてつくりあげます。「オブジェクト」は{}で囲まれた部分のことを指し、「キー」「値」のセットは”キー”:”値”のように書かれた部分を指します。 JSONの概要（9/9） {"success":true,"data":{"name":"Shakespeare","note":"Hamlet","age ":13,"registerDate":"1564-04-26T20:21:00"}} registerDateというキーと、 1564-04-26T20:21:00という値。

Slide 25

Slide 25 text

© 2022 NTT Advanced Technology Corporation 25 ■応答を解析してシナリオ化してみよう JSON形式について理解したところで、今度はシナリオ内でJSONを解析してみます。 HTTPノードの「応答」タブ内を更新し、変数に応答の内容を出力するようにします。さきほど解析した応答.jsonの内容から、応答オブジェクトの中にある２つのキー「success」と「data」をそれぞれ変数に読み込むよう設定します。 HTTPライブラリとJSON応答「キーと値」にチェック「＋」で読み込むデータを追加できる

Slide 26

Slide 26 text

Slide 27

Slide 27 text

© 2022 NTT Advanced Technology Corporation 27 ■変数に読み込まれたJSONの解析 dataの「値」のようなJSONオブジェクトを解析するために、JSON解析専用のライブラリを利用します。今回は「98_構造データ関連」→「01_JSON」の中にある、「JSON変数読み取り」ライブラリを利用します。 ※より詳細なオプションをつけたい方は、「98_ 構造データ関連」→「02_JSON」の中にある、「JSONオブジェクト値の取得」ライブラリを利用してください。応答を解析する（2/5）

Slide 28

Slide 28 text

Slide 29

Slide 29 text

Slide 30

Slide 30 text

Slide 31

Slide 31 text

Slide 32

Slide 32 text

© 2022 NTT Advanced Technology Corporation 32 ■RESTについてもう少し詳しく理解するここまで特に理由もなく使ってきましたが、そもそもシェイクスピアさんのURLってどうやって知るの？という話です。 RESTの説明に立ち戻りますが、今回の資料の一番最初で、次のような説明をしました。大事なのは「パソコン上のファイルパスと同じような構造」という点です。 RESTの階層構造（1/5） https://umayadia-apisample.azurewebsites.net/api/persons/Shakespeare HTTPを利用したAPIは、特にREST APIと呼ばれます。RESTとは設計思想の名称で、平たく言えば「リソースごとにURLをもつ設計」のことを指します。パソコン上のファイルパスと同じような構造と考えてみてください。

Slide 33

Slide 33 text

© 2022 NTT Advanced Technology Corporation 33 ■RESTについてもう少し詳しく理解する URLの後ろの方に注目すると、ファイル・フォルダ階層に似ています。 ↑はシェイクスピアさんのURLですが、例えば織田信長さんのURLは次のようになっています。 RESTの階層構造(2/5) https://umayadia-apisample.azurewebsites.net/api/persons/Shakespeare https://umayadia-apisample.azurewebsites.net/api/persons/織田信長

Slide 34

Slide 34 text

Slide 35

Slide 35 text

© 2022 NTT Advanced Technology Corporation 35 ■階層構造ということは？この構造が見えてくると、例えば「すべての登録済みの人のデータがほしい」と思ったときは、 personsの下の一覧を取得できればよいのでは？と考えられます。 RESTの階層構造(4/5) api persons Shakespeare 織田信長 personsフォルダの中に全員のデータがある

Slide 36

Slide 36 text

© 2022 NTT Advanced Technology Corporation 36 ■つまりこうすれば良いつまり、全員のデータが欲しい場合は、personsまでのURLに対して要求すれば良いということです。多くのAPIではこのような要求を行うことができます。どういった形式で応答されるかはAPIによって異なりますので、その点は注意してください。 RESTの階層構造(5/5) https://umayadia-apisample.azurewebsites.net/api/persons

Slide 37

Slide 37 text

© 2022 NTT Advanced Technology Corporation 37 ■登録されている全員分の名前と年齢をExcelに書き出してみる今度は、特定の一人ではなくpersonsの中にある全員分のデータを取り出して見ましょう。今回は少し難しい処理をするので、 HTTPライブラリは「99_外部サービス連携」→ 「02_HTTP関連」の中にある「HTTP（詳細）」ライブラリを使います。改めて、APIを試してみる

Slide 38

Slide 38 text

© 2022 NTT Advanced Technology Corporation 38 ■登録されている全員分の名前と年齢をExcelに書き出してみる設定することはほとんど変わりません。「基本設定」タブのURLに前述の全員分を取得するURLを、「応答」タブの中の「ボディ」タブ内で、ボディを取得にチェックを入れて変数名を指定します。また、もしプロキシ環境で利用されている場合は「要求」タブの中の「その他」タブ内で、オプション設定のプロキシサーバを使用するにチェックを入れてください。改めて、APIを試してみる /api/personsのURL ボディを取得にチェックを入れて、変数「body」を指定プロキシを使う場合はチェック

Slide 39

Slide 39 text

Slide 40

Slide 40 text

Slide 41

Slide 41 text

© 2022 NTT Advanced Technology Corporation 41 ■応答を解析する文字数が多くて複雑そうに見えますが、こちらも丁寧に解析していきます。 JSON配列(1/11) {“success”:true,“data”:[{“name”:“徳川家康”,“note”:“江戸幕府の初代将軍”,“age”:11,“registerDate”:“1543-02-10T03:04:05”},{“name”:“織田信長”,“note”:“本能寺の変”,“age”:12,“registerDate”:“1534-07- 03T04:14:25”},……………,{"name":"????","note":"????","age":35,"r egisterDate":"1684-11-27T15:18:49"}]}

Slide 42

Slide 42 text

© 2022 NTT Advanced Technology Corporation 42 ■応答を解析する文字数が多くて複雑そうに見えますが、こちらも丁寧に解析していきます。 JSON配列(2/11) {“success”:true,“data”:[{“name”:“徳川家康”,“note”:“江戸幕府の初代将軍”,“age”:11,“registerDate”:“1543-02-10T03:04:05”},{“name”:“織田信長”,“note”:“本能寺の変”,“age”:12,“registerDate”:“1534-07- 03T04:14:25”},……………,{"name":"????","note":"????","age":35,"r egisterDate":"1684-11-27T15:18:49"}]} 応答データのオブジェクト

Slide 43

Slide 43 text

© 2022 NTT Advanced Technology Corporation 43 ■応答を解析する文字数が多くて複雑そうに見えますが、こちらも丁寧に解析していきます。 JSON配列(3/11) {“success”:true,“data”:[{“name”:“徳川家康”,“note”:“江戸幕府の初代将軍”,“age”:11,“registerDate”:“1543-02-10T03:04:05”},{“name”:“織田信長”,“note”:“本能寺の変”,“age”:12,“registerDate”:“1534-07- 03T04:14:25”},……………,{"name":"????","note":"????","age":35,"r egisterDate":"1684-11-27T15:18:49"}]} successというキーと、 trueという値。

Slide 44

Slide 44 text

© 2022 NTT Advanced Technology Corporation 44 ■応答を解析する文字数が多くて複雑そうに見えますが、こちらも丁寧に解析していきます。 JSON配列(4/11) {“success”:true,“data”:[{“name”:“徳川家康”,“note”:“江戸幕府の初代将軍”,“age”:11,“registerDate”:“1543-02-10T03:04:05”},{“name”:“織田信長”,“note”:“本能寺の変”,“age”:12,“registerDate”:“1534-07- 03T04:14:25”},……………,{"name":"????","note":"????","age":35,"r egisterDate":"1684-11-27T15:18:49"}]} dataというキーと、 []で囲まれたなにか？

Slide 45

Slide 45 text

© 2022 NTT Advanced Technology Corporation 45 ■[]で囲まれたなにか？ []で囲まれたものは、JSONにおける配列です。 JSON配列(5/11) {“success”:true,“data”:[{“name”:“徳川家康”,“note”:“江戸幕府の初代将軍”,“age”:11,“registerDate”:“1543-02-10T03:04:05”},{“name”:“織田信長”,“note”:“本能寺の変”,“age”:12,“registerDate”:“1534-07- 03T04:14:25”},……………,{"name":"????","note":"????","age":35,"r egisterDate":"1684-11-27T15:18:49"}]}

Slide 46

Slide 46 text

© 2022 NTT Advanced Technology Corporation 46 ■[]で囲まれたなにか配列は[“要素A”,“要素B”,“要素C”]のように、カンマ区切りで羅列することができます。要素にはオブジェクトを入れることも出来るので、以下のように読み解けます。 JSON配列(6/11) {“success”:true,“data”:[{“name”:“徳川家康”,“note”:“江戸幕府の初代将軍”,“age”:11,“registerDate”:“1543-02-10T03:04:05”},{“name”:“織田信長”,“note”:“本能寺の変”,“age”:12,“registerDate”:“1534-07- 03T04:14:25”},……………,{"name":"????","note":"????","age":35,"r egisterDate":"1684-11-27T15:18:49"}]} 1つ目の要素（オブジェクト）２つ目の要素（オブジェクト）最後の要素（オブジェクト）

Slide 47

Slide 47 text

© 2022 NTT Advanced Technology Corporation 47 ■配列の中身は？配列の要素であるオブジェクトは、先程シェイクスピアさんのときに解析したものと同じ構造です。 JSON配列(7/11) {“success”:true,“data”:[{“name”:“徳川家康”,“note”:“江戸幕府の初代将軍”,“age”:11,“registerDate”:“1543-02-10T03:04:05”},{“name”:“織田信長”,“note”:“本能寺の変”,“age”:12,“registerDate”:“1534-07- 03T04:14:25”},……………,{"name":"????","note":"????","age":35,"r egisterDate":"1684-11-27T15:18:49"}]} オブジェクトの中身はデータのセット

Slide 48

Slide 48 text

Slide 49

Slide 49 text

Slide 50

Slide 50 text

Slide 51

Slide 51 text

Slide 52

Slide 52 text

Slide 53

Slide 53 text

Slide 54

Slide 54 text

Slide 55

Slide 55 text

Slide 56

Slide 56 text

Slide 57

Slide 57 text

Slide 58

Slide 58 text

© 2022 NTT Advanced Technology Corporation 58 ■シナリオ解説の前に… OAuth2.0 ここでの「初期設定」とは、認証処理（＝APIでサービスにログインすること）です。ブラウザからサービスを使うときにログインが必要なように、API連携する時もログイン処理に相当する認証処理が必要なことが多いです。このサンプルシナリオは、その認証処理を行う内容になっています。 DocuSign連携で行う認証処理はOAuth2.0（オーオース2.0）という方式を用いています。多くのサービスで利用されている方式なので、簡単に説明します。

Slide 59

Slide 59 text

© 2022 NTT Advanced Technology Corporation 59 ■OAuth2.0 OAuth2.0概要 OAuth2.0を利用した認証の概念を簡単に説明すると、「アプリケーションがサービスにAPI連携するための定期券をもらう手順」です。定期券をもらうためには一度は手動でログインしなければならない（身分証明書のようなものが必要）ですが、一度定期券をもらってしまえば何度でもAPI連携を利用できます。サービスページアプリケーション認証サーバ本人証明の情報定期券要求

Slide 60

Slide 60 text

© 2022 NTT Advanced Technology Corporation 60 ■初期設定シナリオを実行すると得られるもの DocuSign連携シナリオ① サンプルシナリオの手順通りに実行すると、「Basic認証キー」「アクセストークン」「リフレッシュトークン」の3つのファイルが出力されます。「Basic認証キー」は本人証明の情報、「アクセストークン」「リフレッシュトークン」はAPI利用の定期券に相当します。これでAPI連携の準備は完了です。

Slide 61

Slide 61 text

Slide 62

Slide 62 text

Slide 63

Slide 63 text

© 2022 NTT Advanced Technology Corporation 63 ■Bearer認証 Bearer認証(2/2) ヘッダというのは、HTTPの要求につけるオプションのようなものです。認証が必要なAPIでは、このヘッダに認証情報を設定します。今回連携するDocuSignではBearer認証という認証方式が採用されているので、それに則ったヘッダを設定しています。 Bearer [アクセストークン]

Slide 64

Slide 64 text

© 2022 NTT Advanced Technology Corporation 64 ■認証以外の処理はどうなっている？ API連携後の処理 API連携後の処理は今までと同じく、API連携で取得したJSONを加工するものです。一見複雑に見えますが、「HTTP」と「JSON」の役割を理解するとシンプルな構造になっていることがわかります。 HTTPでAPI連携 API連携で取得したJSONを加工加工したJSONを元にファイル・フォルダの処理

Slide 65

Slide 65 text

Slide 66

Slide 66 text

© 2022 NTT Advanced Technology Corporation 66 ■APIを知る APIリファレンス ※https://developers.docusign.com/docs/esign-rest-api/reference/ API連携を作るためには、URLの情報や認証の手順などを調べる必要があります。通常、APIを公開しているサービスはAPIリファレンス（APIの仕様書）も併せて公開されています。まずはリファレンスを読み、何ができるのかを把握することから始めることをお勧めします。海外のサービスは日本語のAPIリファレンスがないことが多いので、ちょっとハードルが高いです。

Slide 67

Slide 67 text

Slide 68

Slide 68 text

© 2022 NTT Advanced Technology Corporation 68 API連携の総まとめ知識をつけて、よいAPI連携ライフを！サービスと連携する方法はいくつかあります。メリットとデメリットを把握して、目的に合った連携方法を選択しましょう。まずＨＴＴＰライブラリを使ってみることをお勧めします。 APIのサンプルを使って、要求・応答の確認とJSONの構造を理解しましょう。シナリオを作るには、 APIの知識が必要です。まずはリファレンスを読み、 APIで何ができるのかを把握しましょう。画面操作 API連携ファイル操作要求応答 JSON

Slide 69

Slide 69 text

Slide 70

Slide 70 text

© 2022 NTT Advanced Technology Corporation 70 ■プロキシ環境でHTTPライブラリを動かす場合の設定 HTTPライブラリはWinActorのプロキシ設定を参照して動作します。 WinActorをプロキシ環境で利用されている場合は、WinActor本体のプロキシ設定を確認してください。「ツール」メニューの一番下、「オプション」から設定を確認できます。参考１：プロキシ環境での動作

Slide 71

Slide 71 text

© 2022 NTT Advanced Technology Corporation 71 ■シナリオ作成の注意点今回紹介したAPI連携では、応答データを変数に格納する方法を紹介しています。応答データは比較的文字数が大きくなりがちなため、デフォルトのシナリオ設定では文字制限に引っ掛かりやすいです。API連携シナリオを作成される際は、予め変数の文字数制限を解除しておくことをおすすめします。参考2：変数の文字制限シナリオ情報ボタンをクリック「変数の文字数を制限する」のチェックを外す

Slide 72

Slide 72 text

© 2022 NTT Advanced Technology Corporation 72 ■サブシナリオも連携に使える参考3：サブシナリオ WinActor本体には、MicrosoftOffice、GoogleWorkspace、PowerAutomateと連携するサブシナリオが同梱されています。サブシナリオは画面操作で実現されたシナリオですが、メンテナンスはＮＴＴＡＴで実施しているため、画面の更新を気にすることなく利用が可能です。

Slide 73

Slide 73 text

© 2022 NTT Advanced Technology Corporation 73 ■GET,POST,PUT,DELETE 参考4：HTTPメソッドとステータスコード資料中では紹介しませんでしたが、HTTPにはメソッドというものがあります。リソースを取得するにはGET、リソースを新規にアップロードするにはPOST、既存のリソースを上書きするにはPUT、リソースを削除するにはDELETEを設定します。 APIリファレンスを読むと対応するメソッドが記載されていますので、それに合わせて変更してください。 ■ステータスコード HTTPライブラリは、どのような結果になってもエラーを出すことがありません。要求の成否を確認するためには、応答の中にあるステータスコードを見る必要があります。ステータスコードの詳細は省きますが、200番台の番号であれば成功、それ以外であれば失敗と思っていただければひとまずは大丈夫です。

Slide 74

Slide 74 text

© 2022 NTT Advanced Technology Corporation 74 ■Basic認証キーとリフレッシュトークン参考5：アクセストークンの有効期限（1/3）アクセストークンがあればAPIを使えますが、これには有効期限が存在するので、そのうち使えなくなります。じゃあ有効期限が切れたらまた最初からやり直し…というのは面倒なので、登場するのが「リフレッシュ」です。リフレッシュとは、「Basic認証キー」と「リフレッシュトークン」を使うことで、新しいアクセストークンを簡単に取得できる仕組みのことです。 APIは窓口、アクセストークンがチケットとすれば、リフレッシュは定期券の更新のようなもの、と考えるとわかりやすいかもしれません。

Slide 75

Slide 75 text

Slide 76

Slide 76 text

© 2022 NTT Advanced Technology Corporation 76 ■有効期限は短いアクセストークンの有効期限は比較的短い時間が設定されることが多いです。これは、もしアクセストークンが第三者に知られた場合でも、悪用される前にすぐに使えなくなるというセキュリティ上の理由からです。参考5：アクセストークンの有効期限（3/3）一方で、アクセストークンの有効期限が長めに設定されていることもあります。これは、サービス側でリフレッシュトークンの仕組みが用意されていないため、アクセストークンの再発行という面倒な手続きを短い期間に何度も行わないように配慮されている場合が多いです。 ■有効期限が長いものもある

Slide 77

Slide 77 text

© 2022 NTT Advanced Technology Corporation 77 ■OAuth2.0を学ぶときに意識したい「認可」と「認証」本資料では「認可」と「認証」を分けて説明しませんでしたが、OAuth2.0を学ぼうとすると「認可」と「認証」の違いを意識しないとよくわからない部分が出てくると思います。違いを簡単に説明すると、認可は「その要求がどのような権限で行われたのかを確認すること」で、認証は「その要求が誰によって行われたのかを確認すること」です。アクセストークンの仕組みは認可であり、トークンをもらうためのＢａｓｉｃ認証はその名の通り認証に相当します。些細な違いに思えますが、「誰が（認証）」「どのような権限で（認可）」「どのような要求を（HTTP）」「どのリソースに（REST）」行うかを明確にすることは、ＡＰＩ連携シナリオを作るうえで非常に重要です。参考６：認可と認証

Slide 78

Slide 78 text

© 2022 NTT Advanced Technology Corporation 78 ■JSONって何者？ JSON構造はもともとJavaScriptの世界で定義されたもので、あまりに便利だったので後々あらゆる部門で活用され始めたものです。正式な仕様は「ECMAScript 5.1」というJavaScriptの規格の仕様書に記載されています。とはいえAPI連携で利用する範疇であれば、本資料の内容＋α（躓いたときに調べる）ぐらいでも十分活用できると思います。参考7：JSONについて