事例から学ぶ Amazon API Gatewayを利用した API 公開のポイント 株式会社オージス総研サービス事業本部クラウドインテグレーションサービス部齋藤伸也 (Saito_Shinya@ogis-ri.co.jp) Copyright 2017 OGIS-RI Co., Ltd. All rights reserved.
目次 なぜAPIが注目されているのか? API 公開のライフサイクル 事例概要 Amazon API Gateway 利用のポイント APIソリューションご紹介 Copyright 2017 OGIS-RI Co., Ltd. All rights reserved. 2
なぜ API が注目されているのか? Copyright 2017 OGIS-RI Co., Ltd. All rights reserved.
API とは? 最近注目されている API は企業が持つデータやサービスを 他のアプリケーションやプログラムから利用するための窓口を意味する API は HTTP などの Web の技術を用いて構築されたプログラムから利用可能なインタフェース API の例 GET http://api.example.com/items API プログラム { service : [ AAA, BBB, CCC ] } API を現実世界に置き換えたイメージ どんな商品がありますか? ユーザ AAA BBB CCC がございます 窓口担当者 Copyright 2017 OGIS-RI Co., Ltd. All rights reserved. 4
API の技術的背景 プログラミングやソフトウェアの相互運用性を確保するための技術や仕様の策定が行われる - 1998 年 ~2003 年 :XML-RPC SOAP WSDLなどの仕様が策定される - 2000 年 : RESTが提唱される - 2000 年代後半 :GoogleやAmazonなど大手 Webサービス企業がAPIの公開を始める 当時は SOAP REST 両方のスタイルでAPIが提供されていた 現在はRESTのみの提供 最近のAPIはデータ形式としてJSON RESTスタイルが採用されることが多い データ形式 : XML と JSON XML: 表現力が豊か 厳密性 <?xml encoding='utf-8'?> <user> <name>saito</name><age>32</age> <name>yamada</name><age>25</age> <name>kimura</name><age>41</age> </user> JSON: シンプル 相互運用性 {"user" : [ { "name" : "saito", "age" : "32" }, { "name" : "yamada", "age" : "25" }, { "name" : "kimura", "age" : "41" } ]} スタイル : SOAP と REST SOAP: 基本的な考えはリモート関数呼出 URI は関数の集合を表す POST http://domain/api/itemsearchservice 商品一覧取得 POST http://domain/api/itemregisterservice 商品登録 REST: 基本的な考えは HTTP の原理 URI はリソースを表す名詞 GET http://domain/api/items 商品一覧取得 POST http://domain/api/items 商品登録 Copyright 2017 OGIS-RI Co., Ltd. All rights reserved. 5
API の普及 2003 年頃 ~ Amazon Google など大手 Web 企業が API を提供開始 Ajax の普及 2007 年頃 ~ AWS, Salesforce, Twitter, Facebook 等クラウドサービスが API を提供開始 2009 年頃 ~ スマートフォンの普及 モバイルアプリの開発が活発化 モバイルアプリのサーバ ( バックエンド ) とデータをやり取りする 仕組みとして API の普及が本格化 2014 年頃 ~ IoT フィンテックや API エコノミーが注目される非 IT 企業 API への取組み本格化 モバイルアプリと API 増加を続ける API バックエンド DB API モバイル タブレット ProgrammableWeb の情報を基に当社で加筆 グラフ化引用元 : https://www.programmableweb.com/api-research Copyright 2017 OGIS-RI Co., Ltd. All rights reserved. 6
デジタルビジネスの中核となるAPI デジタルビジネスはAPIが有機的に 連携し エンドユーザに様々なモ ノを通じて価値を提供している APIにより部品化されたサービスを組み 合わせてユーザに提供されている API APIは自社のビジネスを サービス の部品化 するために重要な役割 を果たす SNS サービス API API サービス 企業はAPIを公開することで 社外 のサービスやデバイス センサー などと情報の交換が可能となり 顧客に対して新しいサービス体験 を提供できるようになる Copyright 2017 OGIS-RI Co., Ltd. All rights reserved. 物流サービス API クラウドプラットフォーム サービス 7 7
API のライフサイクル Copyright 2017 OGIS-RI Co., Ltd. All rights reserved.
API 公開のライフサイクル API 公開は 一度きりの取り組みではない デジタルビジネスの成長 変化にあわせ API を改修し バージョンアップすることが必要 ライフサイクル管理が大切 API のバージョン リリース管理 API のユーザー トークンの管理 API のユーザー向けサポート API の開発方法 新規に API を構築 既存システムを拡張 ESB/EAI の利用 クラウドサービスの利用 既存システムとの連携 API 公開したいデータを持つシステムと どのようにつなぐか 運用 開発 API 計画 設計 API 公開の目的を明確に API の利用者および公開範囲を明確に API として公開するデータ サービスを明確に API の利用シナリオを明確に API を利用するアプリ システムを含めた全体のアーキテクチャ セキュリティ スケーラビリティ 拡張性 コストを考慮 API のユースケースを実現するデータセット インタフェース Copyright 2017 OGIS-RI Co., Ltd. All rights reserved. 9
API 公開のライフサイクル : 計画 API 公開の計画で重要になるポイント - API 公開の目的を明確にする - API の利用者および公開範囲を明確にする - API として公開するデータ サービスを明確にする - API の利用シナリオを明確にする 運用 開発 計画 設計 API 公開範囲の種類について プライベート パートナー パブリック メリット : 様々なクライアントから共通的に利用可能なモジュールを提供できる 例 : モバイル向けのバックエンド API メリット : パートナーとの新規協業 立ち上げの迅速化ができる 例 : 取引先 代理店向けのカタログ API メリット : ビジネスをプラットフォーム化することを実現できる 例 : オープンに公開されている Map API Copyright 2017 OGIS-RI Co., Ltd. All rights reserved. 10
API 公開のライフサイクル : 設計 API 公開の設計で重要になるポイント - API を利用するアプリ システムを含めた全体のアーキテクチャ セキュリティ スケーラビリティ 拡張性 コストを考慮する - API のユースケースを実現するデータセット インタフェース ユーザ視点のデータセット 標準的な API スタイルなどユーザの利用しやすさを考慮する 運用 開発 計画 設計 アーキテクチャ設計 インタフェース設計 API クライアント API の目的を達成するにはどのような構造にするべきか API ユースケースの視点 ユースケースを実現する API セットは? 申請 API 申請ステータス確認 API 申請一覧取得 API 申請キャンセル API 申請 API の申請情報はどのようなデータ項目を持つべきか? API 技術の視点 API のスタイルは SOAP か? REST か? データフォーマットは XML か? JSON か? Copyright 2017 OGIS-RI Co., Ltd. All rights reserved. 11
API 公開のライフサイクル : 開発 API 公開の開発で重要になるポイント - API の開発方法 新規に API を構築 既存システムを拡張 ESB/EAI などの連携ミドルウェアの利用 クラウドサービスの利用 - 既存システムとの連携 運用 開発 計画 設計 API 公開したいデータを持つシステムと どのようにつなぐか 何をつかって開発する? どうやって連携する? クラウドサービスを利用するか? PaaS BaaS FaaS 新規に構築するか? Java.Net Ruby Python Node API クラウドサービスを利用するか? PaaS BaaS FaaS DB に直接接続するのか? 既存システムに連携のインタフェースが必要か? API? Copyright 2017 OGIS-RI Co., Ltd. All rights reserved. 12
API 公開のライフサイクル : 運用 API 公開の運用で重要になるポイント - API のバージョン リリース管理 - API のユーザ 契約管理 - API のユーザ向けサポート - API の監視 障害対応 運用 開発 計画 設計 API の機能追加やデータ項目変更などの管理する API ユーザや管理 API を利用するためにトークンの管理 API の使い方を理解するためのドキュメント SDK バージョン ライフサイクル ユーザ ユーザプロファイル変更 API 1.2 公開中 契約や API 利用の課金情報の管理 開発支援 サービス取得 API 0.1 開発中 開発者 API 利用契約 Copyright 2017 OGIS-RI Co., Ltd. All rights reserved. 13
事例概要 Copyright 2017 OGIS-RI Co., Ltd. All rights reserved.
事例 パーソルキャリア株式会社様 ( 旧名 : 株式会社インテリジェンス様 ) アルバイト求人情報サービス an の法人顧客向けサービス向上のために API 公開支援ソリューション を採用 Copyright 2017 OGIS-RI Co., Ltd. All rights reserved. 15
背景 課題 公開版につき削除 : 詳細はお問い合わせください Copyright 2017 OGIS-RI Co., Ltd. All rights reserved. 16
API による課題の解決 公開版につき削除 : 詳細はお問い合わせください Copyright 2017 OGIS-RI Co., Ltd. All rights reserved. 17
プロジェクトの目的 スモールスタート 現行システムへの影響をできるだけ小さくする APIのセキュリティ 将来に向けて拡張できるようにする Copyright 2017 OGIS-RI Co., Ltd. All rights reserved. 18
Amazon API Gateway 利用のポイント Copyright 2017 OGIS-RI Co., Ltd. All rights reserved.
API Gateway 採用の目的 API の認証認可を内部 API の実装から分離 - API に対するアクセス制御を実現 API のユーザ クライアント トークンの管理のサービスと連携 - AWS IAM AWS Cognito や外部の仕組みと連携可能 API の流量制御 ( スロットリング機能 ) - バックエンドの内部 API の負荷が過大にならないようなトラフィック制御 効率的な支払いモデル - 利用量 (API の呼び出しと データ量 ) に応じた課金 Amazon API Gateway Copyright 2017 OGIS-RI Co., Ltd. All rights reserved. 20
ハイブリッド構成における役割 API Gateway API サーバ ( 内部 API) - API クライアントの認証 - 流量制御 - HTTP リクエスト / レスポンスのハンドリング - HTTP リクエストバリデーション - DB アクセス - エラーハンドリング Copyright 2017 OGIS-RI Co., Ltd. All rights reserved. 21
セキュリティ : ネットワーク パブリックサービスである API Gateway からオンプレミスにある内部 API サーバにセキュアに接続するか - ネットワークセグメント分け (VPC + Direct Connect) - API Gateway から内部 API サーバのリクエスト クライアント証明書認証 Basic 認証 Copyright 2017 OGIS-RI Co., Ltd. All rights reserved. 22
流量制御 ( スロットリング ) トークンバケットアルゴリズム : ネットワーク流量をバケット ( バケツ ) 内のトークンに基づいて制御する - レート : トークンがバケットに追加される量 1 秒あたりのリクエストの平均数 - バースト : バケットに入るトークンの最大数リクエストの瞬間最大値 トークンは 1 秒毎に追加される 1 リクエストを流すのに 1 トークンを消費 バケツにトークンがなくなると リクエスト 仮想のバケツ リクエスト HTTP レスポンスコード 429 Too Many Request Copyright 2017 OGIS-RI Co., Ltd. All rights reserved. 23
現行システムへの負荷軽減 / レイテンシー 現行システムへの影響をできるだけ小さくする - 流量制御 ( スロットリング ) - キャッシュ - 1 レスポンスあたりのサイズ制限 レイテンシー - キャッシュ API Gateway のキャッシュ API サーバのキャッシュ どこに どのデータをキャッシュさせておくか 各要素で処理を最適化する クライアント API Gateway API サーバ DB DB のキャッシュ - クエリの最適化 API 処理の効率化 Copyright 2017 OGIS-RI Co., Ltd. All rights reserved. 24
エラーハンドリングと HTTP レスポンス エラーの発生箇所 発生原因に応じて適切な HTTP レスポンスをマッピングする - API Gateway で発生するパターン - 内部 API サーバで発生するパターン 公開版につき削除 : 詳細はお問い合わせください 公開版につき削除 : 詳細はお問い合わせください クライアント API サーバ API Gateway Copyright 2017 OGIS-RI Co., Ltd. All rights reserved. 25
API Gateway の組み込み変数を活用する API 呼び出しのコンテキスト情報をメタデータとして内部 API 呼び出しのリクエストに付与する - $context.identity.xx : リクエストを呼び出しているアカウント情報 - $context.requestid : API 呼び出し用に自動生成された ID サンプルリクエスト 組み込み変数を 内部 API の HTTP リクエストに付与する クライアント 公開版につき削除 : 詳細はお問い合わせください API Gateway API サーバ XXX の値によって振る舞いを変える XXX をログに出力し リクエストのトレーサビリティを確保する Copyright 2017 OGIS-RI Co., Ltd. All rights reserved. 26
API バージョン リリース管理 API のバージョン リリース管理 - 外部インタフェース Amazon API Gateway の ステージ によって管理 - API 定義は Swagger ファイルをバージョン管理システムで管理 クライアント API Gateway のステージは 開発や本番などのデプロイに紐付いた概念 URL にマッピングされる http://[ ホスト名 ]/[ ステージ名 ] Copyright 2017 OGIS-RI Co., Ltd. All rights reserved. 27
当社 API ソリューションご紹介 Copyright 2017 OGIS-RI Co., Ltd. All rights reserved.
API 公開支援ソリューション オージス総研のクラウドと API 開発 運用の知見を集めたサービスで 短期間で API 構築 信頼性の高い API インフラ を提供します こんなお客さまに最適です やりたいこと 新たなデータ販売チャネルを開拓したい ビジネスパートナーからのAPI 対応の要望に応えたい モバイルやIoTデバイスを活用し 新しいビジネスモデルを構築したい 活用シーン 悩み API の設計 実装 運用 監視の設計 など技術面でのサポートが欲しい 最初の取り組みとして最小構成でスタートしたい API 提供により ビジネスパートナーのサービスとデータを連携する API 活用により 様々なデバイスやアプリとサービスを連携する Copyright 2017 OGIS-RI Co., Ltd. All rights reserved. 29
サービスメニュー API 構築サービス API プラットフォーム構築 API 開発 クラウド ハイブリッド オンプレミスに対応要件にマッチした製品 / サービスを利用してご提供 AWS IBM API Connect Anypoint Platform API 開発のベストプラクティスを詰め込んだ API 開発スタックを使い 効率的に API を開発 API 運用サービス APIアップデート APIプラットフォームメンテナンス APIプラットフォーム監視 API 障害分析 対応 API 利用状況レポート APIユーザサポート API のデータ項目の追加など API のアップデート リリースの実施 定期的な API プラットフォームのセキュリティアップデート API プラットフォームの障害 異常検知および通知 障害発生時の原因調査 切り分けおよび復旧対応 API の利用状況のレポーティング API 利用者への問い合わせ対応 API クライアント開発支援 Copyright 2017 OGIS-RI Co., Ltd. All rights reserved. 30
まとめ API 公開のプロセスをご紹介 - API の利用者を想定し 様々な角度から検討する - 基礎となるアーキテクチャを構築する - 一度きりのプロセスではなく 継続的なサイクルを実施する スモールスタートの API 公開事例をご紹介 - クラウドサービスを活用したハイブリッド構成 - 既存システムへの影響を小さくするための方策 Amazon API Gateway のポイントをご紹介 - 内部 API を保護する役割として利用したケース - 内部 API との機能分割や API Gateway の機能の使い方 Copyright 2017 OGIS-RI Co., Ltd. All rights reserved. 31