APIソリューション・セミナー

Transcription

1 API ソリューション セミナー 既存システムの API 化をワンストップで実現! API エコノミーとバイモーダル IT に対応した最新の MQ ファミリーをご紹介

2 第一部 API エコノミー Bi-Modal IT 時代に求められる IT 基盤とは 2

3 概説 3

4 急変するビジネス環境 4

5 業界の統合 融合 が重大な影響を及ぼす 5

6 API エコノミー = テクノロジー視点でみた業界の融合 電鉄系企業のパートナー連携ユースケース 銀行にとっての 新たな顧客 鉄道 バス タクシー 旅行 ゴルフ API公開候補 時刻表 座席予約 チケット発券 配車 乗り継ぎ案内 API公開候補 ツアー組み立て 申し込み 支払い オプション追加 API 銀行の公開 API API API デパート 小売ストア 保険 API API API公開候補 商品検索 シミュレーション 申し込み 保険シェアリング 超短期旅行保険 個客 API 人材 介護 API公開候補 ケア住宅紹介 入居契約 ケア マネージャ派遣予約 ケア サービス タクシー配車 レストラン API公開候補 パーソナル キャンペーン ポイントでの購入 支払い API API公開候補 口コミ収集 提供 予約 団体対応 季節 イベントメニュー開発 6

7 なぜAPIに取り組むのか アプリ開発 スピードの向上 Systems of Record を安全に開放する ブランド イメージの向上 新たな ビジネスの実現 セルフ サービス のライブラリや再 利用可能なAPI モバイル IoT ク ラウドへアプリや データを提供 革新的なパート ナーとの連係 データやアルゴリ ズムを収益化 7

8 デジタルIT アプリケーション開発速度はますます加速しています 高速なアプリケーション開発を実現するために APIとして公開された外部サービス部品を組み 合わせるコンポジット アプリケーション開発スタイルが広まっています RabbitMQ 脆弱性 分析 モバイル SDK モバイル アクセス モバイル セキュリティ SSO エンタープライズ 固定IP 翻訳 性格解析 品質管理 トレードオフ MQ Light Ustream プッシュ 通知 アジャイル スケジューラ 音声認識 Twilio 画像解析 JMeter 監視 モバイル セキュリティ オートスケール New Relic DevOps ワークフロー キャッシュ Sendgrid ビジネウ プロセス セッション キャッシュ MongoDB Twitter ElasticSearch Cloudant NoSQL Hadoop Redis Geo PostgreSQL ウェブアプリ IoT IoT DB+分析 Watson 連携 DWH Spark オンプレ 連携 API管理 8

9 Bi-Modal ITの問題 ガートナーのレポートによると テクノロジー関連費用のうち 38 がIT部門以外の事業部門か ら支出となっており 2017年にはその割合は50%が超えると予想されています デジタルIT エンタープライズIT 迅速に新サービスを投入 するためには社内ITへの 迅速なアクセスが必要 システムの継続的な改善 マイクロ サービス クラウド コスト削減の圧力の中 更 なる短納期を実現するのは 困難 安定性 信頼性 運用最適化 サービスレベル重視 長期に渡るシステム開発 9

10 API Bi-Modal ITに対する現実解 ④ 革新的 な アイデアをアプリ化 ③開発者が セルフ サービスで 利用できるようになり ②APIとして 公開する ①既存 エンタープライズ IT資産を セルフ サービス化によって 新規アプリケーション用の連携IF準備の手間を大幅に低減しながら 業務部門の求めるスピードで既存IT資産へのアクセスを提供可能に 10

11 APIの利用シーンは外部連係に限定されません Public 公開範囲 一般公開 Protected Private 限定公開 非公開 API対象者 一般の開発者 ビジネス パートナー 自社内開発者 想定される アプリ利用者 消費者向け 消費者向け または 法人向け 目的 プロセスの自動化や 外部リソースを活用し EDI 新規パートナー たイノベーションの 協業の立ち上げ負荷 実現 低減 ユースケース例 営業店の位置情報 預 口座集約サービスへの 社内タブレットアプリ 金や住宅ローン金利 残高情報提供 企業間 での利用 情報系 勘 プレスリリース でのデータ連携 定系情報の統合 従業員向け 生産性向上や チャネ ル間の情報共有 内部 からの改革の推進 11

12 既存 IF を API として整理することのメリット 開発者ポータルから新たな連携をセルフ サービスで利用可能になる システムへのアクセス状況の可視化 管理が容易になる 社内外サービスが一貫した方法で再利用可能となり アプリケーション開発のスピードが上がる 12

13 API公開に伴って発生する周辺課題 安全にAPI公開したい API利用者ごとに API利用可否を 適切に制御したい APIを公開したい 社内開発 コミュニティ パートナー コミュニティ アプリケーション API 企業内システム APIの開発 保守を 低コスト 短期間で行いたい ネットワーク 一般開発者 コミュニティ API利用者向けの ガイド方法が分からない 誰がいつどれだけAPIを 利用しているか把握したい 13

14 API化に必要なこと API管理 インテグレーション アプリ開発者 API Portal 取引先 社内 クライアント アプリ API B2B IoT モバイ ル API API Web SaaS API Gateway 外部 ESB Web Service IBM z REST/JSON 14

15 デジタルITをサポートするAPIアーキテクチャ API Connect アプリ開発者 開発者ポータル -API仕様の開示 -APIキーの管理 外部 取引先 社内 APIマネージャー クライアントアプリ 公開API IoT B2B モバイル Web SaaS 公開API API Gateway Data Power Micro Gateway -APIを保護 制御 -高度なｾｷｭﾘﾃｨｰ -ポリシー管理 -利用分析 IBM Integration Bus 内部API 内部API Compute -APIの実行 Web Service -多様なバック エンドのAPI化 IBM z 15

16 ( 空白ページ ) 16

17 IBM の提供するソリューション 17

18 ( 空白ページ ) 18

19 IBMの提供するソリューション IBM Integration Bus IBM API Connect アプリ開発者 APIマネージャー 外部 取引先 バックエンド システム API Connect -ポリシー管理 -利用分析 社内 クライアントアプリ 開発者ポータル -API仕様の開示 -APIキーの管理 B2B IoT IBM Integration Bus - 既存システム 間連携の仲介 - 既存IFのAPI 化 API Gateway モバイル Web SaaS 内部API 公開API 既存IF -セキュリティ -トラフィック制御 DataPower 19

20 IBM Integration Bus の実績 80% 世界の航空券予約システムで利用 20 社 世界の大手通信サービス会社が採用 21 / 25 世界で最大手の保険会社が採用 23 / 25 アメリカの大規模小売業で採用 / 世界で最大手の銀行が採用 90% 世界のクレジット カードのトランザクションで利用 20

21 IBM Integration Bus(IIB) IBM Integration Bus は広範な連携要件に対応する IBM の戦略的システム統合製品 多様なシステム間の間にハブとして配置され 異なるプロトコル データ形式 制御の違いを吸収 IIB の役割 メディエーション ( 仲介 ) 1 プロトコル変換 2 データ フォーマット変換 3 ルーティング その他システム共通の関心毎 - ロギング 監査証跡 - 認証 認可 - 流量制御 - 開閉塞管理等 幅広いシステム間の連携を実現 対応システム : メインフレーム UNIX/Linux, ERP, データベース等 対応プロトコル :Web サービス /REST/ ファイル / データベース /TCP/ メール / MQTT/CORBA/MQFTE/C:D 等 対応データ形式 : 固定長 可変長 文字列 バイナリー 高い信頼性と多数の実績 金融決済や銀行の勘定系接続や半導体工場の製造制御等 高い可用性が求められる連携で多数の実績 国内 200 社以上海外 3000 社以上 高パフォーマンス / 拡張性 少ないコア数で連携処理が可能なため SW 費用 HW 費用 運用費を低く抑えることが可能 使いやすくシンプルな製品構成 DBMS やアプリケーション サーバー等前提製品の導入が不要 開発ツールとランタイムの導入は数分で完了 単一の開発ツールで構成 開発 デプロイ テストが完結 21

22 IBM Integration Busの歩み V1.0 V2.0 V V V6.0 V WebSphere MQSeries Integrator (MQSI) WebSpher Business e MQ Integration Integrator Message Broker (WMQI) WBIMB V V V V WebSphere Message Broker IIB IBM Integration Bus V2.0 V2.1 V5 V6 V6.1 V7 V1.0 V8 V9 V10 ツールキット Javaノード Webサービス強化 シンプルな構成 ルールエンジン ノードを組み合わせた TDSメッセージ.NETサポートの追加 BRMSの統合 柔軟なMQ構成 フロー開発 ESQLの拡張 Eclipseベース Webサービス強化 ファイル機能 パターンの提供 Express Edition追加 ポリシーベースの MQTT用ノード V2.0.1 デバッガーの提供 デプロイの変更 パーサー拡張 コレクター ノード インパクト分析 フロー作成API提供 負荷管理機能 導入の簡素化 各種ノードの提供 Webサービスサポート タイマーノード WSRRとの連携 MBXによる管理の統合 ESQLのサポート DFDLサポート BPMとの連携強化 ブラウザ管理画面 高速Pub/Sub ESQL機能拡張 SOAPノード マルチインスタンスQmgr DBアクセス ブラウザによる管理 の機能強化 EIS接続 への対応ブローカー Pub/Sub XMLメッセージ Record & Replay GUIマッピング (SAP Siebel etc.) SCA ノード V2.0.2 の機能強化 MQ Pub-sub の統合 コントロールセンターの日本語化 EAI/HUB ESB MQ MQ MQSI MQ ESB MQ MQ ERP RDB MF WMB Java MQ MQ ERP RDB MF MQ MQ.NET MQ Webサービス MQ MQ MQ IIB MQ Webサービス MQ Business Rule Analytics MQ IoT Java.NET MQ MQ 22

23 IIB 製品全体像 ランタイム環境 JVM Web 2.0 Devices MQ, JMS, MSMQ メッセージ フロー 統合フロー Applicati ons CLR データ モデル IBM MQ IIBに付属 IBM Integration Toolkit Files ERP/EIS /CRM Web管理画面 Java API REST API WAS管理コンソール プラグイン コマンド ツール他 開発 管理環境 稼動プラットフォーム コンポーネント 実行環境 統合ノード 開発ツール (Integration Toolkit) サポート プラットフォーム AIX HP-UX Linux(x86 x86-64 POWER System System z) Solaris(x86-64 SPARC) Windows(x86-64) z/os Windows(x86-64) Linux(x86, x86-64) 23

24 IIB の特長 : 多様なプロトコル対応 IIB がサポートする多様なプロトコルはノードと呼ばれるメッセージ フロー内に配置可能な部品で抽象化 IBMプロトコル ODBC/JDBC (DB2, Oracle, Sybase, Connect:Direct MS SQL Server 等 ) ( グローバル標準のファイル転送 ) WebSphere MQ ( エンタープライズ メッセージング ) SCA (IBM BPM Advanced) CORBA 標準プロトコル サードパーティの JMS (TIBCO EMS, Sonic MQ, BEA JMS, webmethods, See Beyond, Vitria) HTTP および HTTP(S) MQMFT (MQ Managed File Transfer) Web サービス (SOAP/HTTP,SOAP/JMS) WSRR (WebSphere Service Registry and Repository ) FTP およびファイル TCP/IP ソケット SAP PeopleSoft CICS Siebel IMS Loopback Connector SMTP MQTT POP3/IMAP エンタープライズ アプリケーション 24

25 IIBの特徴 多様なデータ形式に対応 多様な形式のメッセージ同士を変換するため IIBはメッセージをパースし論理形式でメモリー内に展開 非標準データ形式のための強力なパーサー DFDLパーサー DFDL形式で定義されたデータのレイアウト情報を参照しながら多様なタ形式のデータをパース/シリアライズ Physical John Smith... Graphics Card CBL John,Smith,Graphics Card, 32,200,07/11/14 CSV アプリケーションとIIBがやり取りするデータ 様々な形式がある Logical メッセージ フローで扱われるデータ 物理形式表現を排除 DFDL DFDL DFDL (レイアウト定義 参照 DFDLパーサー Order その他独自形式 XML { order : { name : { first : John, last : Smith }, item : Graphics Card, quantity :32, price :200, date : }} JSON Name <order> <name> <first>john</first> <last>smith</last> </name> <item>graphics Card</item> <quantity>32</quantity> <price>200</price> <date> </date> </order> Item Qty Price Date XMLパーサー First Last JSONパーサー 25

26 DFDL(Data Format Description Language) XML Schema 1.0 をベースにした 非 XML データの標準モデリング言語 XML スキーマを固定長やタグ区切り文字などの非 XML データ フォーマットを扱うように拡張した規格 テキスト バイナリー 可変長 固定長等 多様なデータ形式のデータをモデル化 DFDL のメッセージ モデルを準備する方法 COBOL のコピー句や C のヘッダーファイルをインポートして生成 ウィザード /DFDL エディターにより作成 GitHub から入手 HL7 ISO8583 IBM 4690-TLOG 等 各種メタ データ XML WSDL スキーマ COBOL Cヘッダーコピー句 生成 メッセージ モデル GitHub からダウンロード 生成 生成 ウィザード 26

27 IIB が提供する変換インターフェース メッセージ変換 ルーティング等 メッセージに対するロジックの記述に複数の選択肢を提供 スクリプティング Java GUI マッピング.NET 強力な変換を迅速に記述 SQL ベースの言語 (ESQL) を使用 RDBMS に加え メッセージ ツリーに対してもクエリー 任意の Java コードを実行可能 Xpath や DOM に似た API でメッセージ ツリーにアクセス JAXB でメッセージ ツリーと Java オブジェクトの間のバインディングも可能 マップ元 / マップ先をワイヤリング 必要に応じてマップの際に関数を実行可能 カスタムの関数を作成可能 GUI によるデータベースアクセスも可 C# VB F# C++/CLI Jscript などにおける変換を作成 共通言語ランタイム (CLR) に対応 Windows 版のみで提供 高い開発生産性 既存 Java コードの再利用 直感的な開発 Microsoft 製品との高い親和性 27

28 パターン IIB の機能例 グローバル キャッシュ MyVar = Cache.Value = 42; Cache.Value; IIB Node 1 IIB Node 2 フェール オーバー機能 Cache.Value = 42; バージョン間の互換性 メッセージの記録と再生 v7 v8 v9 v10 Chef による運用自動化 流量制限 統計機能 28

29 IBM Integration Bus V10 以降の新機能 4 半期ごとの継続的な機能追加 機能強化 誰でもダウンロード可能な継続的な Open Beta IIB v Q IIB v Q Business Transaction Monitoring CICS 2 Phase Commit on zos Oracle stored proc in GDM Linux Power 8 Little Endian (RHEL7.1, Ubuntu , SLES12) IIB v Q Callable Flows for linking to IIBoC Create a REST API without Swagger JSON Schema support for GDM Salesforce Request node LDAP Authentication Web UI Activity Log SLESv12 (x86 and Z Systems) Open Beta Single Package install Built in Unit Test MQ Flexibility Shared Libraries GDM Schemaless maps REST APIs MQTT Connector IIB v Q Maintenance only IIB v IIB v Q Global Cache upgrade to WXSv8.6 GDM access to Global Cache REST API integration with APIm CICS 2 Phase Commit TCPIP report properties enhancements WESB conversion enhancements IIB v Q MQTT SSL and dynamic config Bulk Push to API Connect Callable Flows report properties REST Request node Loopback Request node JSON data in Graphical mapping 29

30 IIB の REST API 機能強化の変遷 FixPack レベルごとの REST API 関連の機能強化 バージョン 追加機能 Swagger 文書をインポートして REST API サービスを提供する REST API アプリケーション を追加 IIB で開発した REST API アプリケーションをツールキットから API Connect に Push する機能を追加 Integration Toolkit で API 定義を作成する機能を追加 REST API 操作を Mapping ノードで実装可能 IIB で開発した REST API アプリケーションを API Connect に対し Web UI または mqsipushapis コマンドを使用して Push する機能を追加 Swagger 文書に基づいて外部 REST API を呼び出す機能が追加 マッシュアップが可能に 30

31 IIB V10 REST API 連携機能 REST APIの記述の標準仕様 Swagger 2.0に対応したREST APIエディター機能を搭載 Swagger文書をインポートしてREST API公開のためのプロジェクトを生成 新規にREST APIエディターでSwagger文書を定義することも可能 Swagger文書として保 存される 31

32 IIB V10 REST API 連携機能 Toolkit上で定義/インポートしたAPI定義からフローの雛形が自動生成 既存連携インターフェースをノンコーディングでJSON形式に変換 REST API定義から生成されたフローに既存MQインターフェースを呼び出す連携を実装 COBOLコピー句からイン ポートして作成した固定 長のメッセージ モデル Swagger文書のJSONス キーマで定義されたモデ ル

33 IIB V10 REST API 連携機能 IIBサーバー上にデプロイしたREST APIは API ConnectにPushすることが可能 IIBにデプロイされた APIをツールキット 上で選択して右クリ ックしてPush PushされたAPIは API Connect上で 即座に利用可能に 33

34 Web 管理画面上の API IIB サーバー上にデプロイした REST API は IIB の Web 管理画面で表示 管理可能 API 仕様の確認と Swagger 文書のダウンロード API Connect への API の Push 34

35 IBM Integration Bus で API 化する理由 多種多様な既存業務システムの API 化に利用可能 MQ, CICS, IMS, SAP, TCP/IP, RDB, File API 化を一元的に行う基盤を担うことのできる信頼性 15 年以上にわたりミッション クリティカルなシステム連携を支えてきた実績 API 化の費用と時間を節約 システム連携に特化したツールを活用することで高い開発生産性を享受可能 継続的な投資と安定したロードマップ IBM Integration Bus は高い市場シェアを持つ IBM の戦略的投資分野 35

36 IBM Integration Bus: 開発者版 36

37 IBMの提供するソリューション IBM Integration Bus IBM API Connect アプリ開発者 APIマネージャー 外部 取引先 バックエンド システム API Connect -ポリシー管理 -利用分析 社内 クライアントアプリ 開発者ポータル -API仕様の開示 -APIキーの管理 B2B IoT IBM Integration Bus - 既存システム 間連携の仲介 - 既存IFのAPI 化 API Gateway モバイル Web SaaS 内部API 公開API 既存IF -セキュリティ -トラフィック制御 DataPower 37

38 IBM API Connect概要 IBM API Connect はAPI公開の課題を解決する包括的なAPI基盤ソリューション API化に向けての課題 ソリューション APIにより連携の 1 安全にAPI公開したい 2 API利用者ごとにAPI利用可否を 適切に制御したい 3 APIの開発 保守を 低コスト 短期間で行いたい 4 誰がいつどれだけAPIを利用 しているか把握したい APIアクセスの 5 API利用者向けのガイド方法が 分からない 公開したAPIを手間なく利用してもらう セルフ サービス化の仕組み 数分でAPIをノンコ ーディングで開発 特 長 LoopBackフレームワーク により 各種データベースの コネクターを利用して ノン コーディングで簡単にAPIを 自動作成 テスト ビルド デプロイも容易 セキュリティーを確保できる API利用企業 開発者ごとの アクセス管理と流量制御 APIの開発 保守コストを削減し 公開までの期間を短縮 利用状況分析 トレンド把握 パブリック クラウド オンプレミス 簡単な操作でAPI公開 分析や開発者ポータル もすぐに使える 少ないコンポーネント でシンプルな構成 強固なセキュリティー 仕様を標準サポート クラウドからオンプレ まで柔軟な提供形態 管理者向けのAPIマネージ ャーは直感的で使いやすく API公開の設定や分析 機能もすぐに利用可能 カ スタマイズ可能な開発者ポ ータルも標準機能で提供 シンプルな構成で クラスタ ー構成やスケーラビリティーを 確保 別途追加でAPサー バーやDBサーバーの構築 運用は不要なので運用維 持コストも少ない 長年に渡り国内外多くのお 客様でWebサービスを保護 してきた実績を持つ DataPowerを活用 より安全な仕組みをアプライ アンスですぐに利用可能 オンプレミスやIaaSの専用 環境やBluemix Public 専用環境のBluemix Dedicated上のSaaSサー ビスを用途に応じて豊富な 選択肢から選択可能 38

39 API ゲートウェイ IBM API Connect 概要 デジタル IT をサポートする API アーキテクチャー API 基盤を支える各コンポーネント シンプルで高機能なツールとランタイムが API 基盤を最適化します アプリ開発者 開発者ポータル API マネージャー API サービス API マネージャー API プロバイダーに必要な機能を提供 開発者ポータル アプリ開発者向けの API リファレンスと API キー発行管理 IoT B2B Web モバイル SaaS クライアント アプリ API 仮想アプライアンス WAS Liberty Collective Controller Node.js API ゲートウェイ 安全で高性能な API ゲートウェイ API デザイナー (Developer Toolkit) 高速でアジャイルな API 実装 費用 サポート ケ ートウェイ 機能 3 段階のエディション 開発者向け単一プロジェクト向け大規模プロジェクト向け Essentials 無償 サポートなし マイクロ ケ ートウェイ 基本機能 Professional 有償 IBM サポートあり マイクロ ケ ートウェイ Essentials+α Enterprise 有償 IBM サポートあり マイクロ ケ ートウェイ / DataPower ケ ートウェイ Professional+α 2つの課金モデル Essentials Professional Enterprise サブスクリプション ( 利用量に応じた月額課金 ) APIコール数 5 万回 / 月 500 万回 / 月 2500 万回 / 月永久ライセンス (CPU 能力とコア数による課金 ) APIコール数 5 万回 / 月無制限無制限 39

40 API Connect が提供するセキュリティー IBM API Connect は API Gateway として業界最高水準のセキュリティー ゲートウェイである DataPower Gateway を採用しています DataPower Gateway は 幅広いセキュリティー仕様を標準サポートしている強固なアプライアンスです IBM API Connect は DataPower Gateway のセキュリティー機能を最大限に活用できるとともに 追加で API 基盤として必要となる高度なセキュリティー機能を容易に実現することが可能なアーキテクチャーです API Connect として提供されているセキュリティー機能 基本認証 (LDAP 認証 URL) による API の認証 OAuth 2.0 による認可 API キー ( クライアント ID)& シークレットによるアプリ認証 SSL/TLS による暗号化 API キーおよびシークレットの発行機能 Developer ごとの API の可視化制御 API ごとのアクセス制御と柔軟なレート制限 API アクセス履歴の取得 IBM DataPower Gateway のセキュリティー機能 認証 ユーザーアクセス制御 シングル サインオン 電子署名 / 検証 リバースプロキシー SSL/TLS 暗号 復号 PKI OAuth 2.0 準拠 認可フォームのカスタマイズ OAuth 2.0 外部認証のサポート SAML/XACML/WS-*/JWT/RADIUS OpenID Connect/SPNEGO/Kerberos 業界標準に基づいたアクセス管理 サードパーティ製認証システムとの連携 メッセージのフィールドレベルの暗号 / 復号 不正 XML/JSON による脅威からの防御 XML JSON SOAP メッセージの構造の妥当性の高速検査 コンテンツ ベースの流量制御 監査ログ出力 メッセージ コンテンツ フィルタリング 署名 暗号化されたファームウェア Internet Content Adaptation Protocol (ICAP) FIPS への準拠と CommonCriteria 認定 FIPS Level 3 準拠と CommonCriteria 認定 (*) 開封検知 (*) (*) 物理アプライアンスのみの機能 40

41 アクセス管理と流量制御 APIキーによるアクセス制御と流量制御 開発者ポータルではアプリケーション開発者がセルフ サービスでAPI利用登録 利用登録はプランとよばれる単位で行われ 呼出し可能数等 利用条件の異なる複数のプランが提供可能 利用申請完了時にAPIを利用するアプリケーションの識別情報 APIキー が発行 API ConnectはAPI要求に付加されたAPIキーの情報を基にアプリケーションごとにプランに応じた呼び出し回数に制 限したり 必要に応じて特定のアプリケーションからの要求を拒否するなどの制御を行うことが可能 開発者ポータルのプラン登録画面 プランの選択画面例 プランの選択ボ タン 利用可能なプラン APIキー クライアントID の発行例 API利用登録時に 発行されるAPIキ ー APIキー クライアント ID 開発者は利用条件の異な る複数のプランから条件 にあうものを登録 41

42 API利用状況の把握 APIキーの情報を基にアプリケーションごとのAPIを呼び出し状況を分析するダッシュボード機能 収集した分析データをAPI利用課金の基礎情報として利用可能 ⑤分析データは APIを利用して データとしてエクスポート可能 ③蓄積された分析データを 分析ダッシュボード上で分析 分析 データ APIマネージャー API管理者 IoT Web API B2B モバイル SaaS API ゲートウェイ 内部API クライアント アプリ 分析ダッシュボード表示例 ④ダッシュボード上の元データは CSVデータとしてエクスポートする ことが可能 ①事前登録されたプランに基づい てAPIの呼び出し回数をコント ロール ②APIゲートウェイを通過するAPIトラ フィックの情報は APIマネージャーに 非同期で送信される 42

43 開発者ポータル ブランド イメージに合わせた画面のカスタマイズ シンプルな操作で柔軟性の高いカスタマイズ 柔軟な認証方式 外部開発者 gmailアカウントで認証 社内開発者 社内SSO基盤で認証 プランへのアプリケーション登録 開発者にセルフ サービスのAPI利用申請を提供 利用開始前に承認を行う設定も可能 APIキーの発行 開発者ポータル画面例 ブログ機能 フォーラム機能 サポート機能 チケット発行 開発者サポート フォーラム機能による開発者コミュニティーの醸成 問題報告のためのサポート チケットを発行機能 ブログ機能による開発者向けの情報発信 - APIの仕様 - プランの表示 選択 - FAQの表示 言語ごとのサンプルコード curl Ruby Python PHP Java Node Go Swift サンプル コードの表示とAPIのテスト リクエスト レスポンスの サンプル表示 APIのテスト実行 43

44 IBM API Connect の価値 API 公開の課題をワンストップで解決 IBM の長年の経験からのベスト プラクティスを組込み API ライフサイクル ( 設計, 開発, 公開, 管理 ) をカバーする包括ソリューション バージョニングやトラフィック制御などのポリシーを適用可能 自由にカスタマイズ可能なポータル ハイブリッド クラウドに対応したオープンかつセキュアな API 基盤 Open API Initiative を始め API 標準への積極的な関与と機能拡張 2200 以上のお客様での導入実績を持つ API ゲートウェイ (DataPower) の提供 メインフレームを含めた多様なバックエンドを接続する IBM Integration Bus との親和性 エンタープライズ クラスの高度な要求にも対応 ビジネス規模に応じてスケール可能するアーキテクチャと価格体系 共有 SaaS 占有 SaaS オンプレミスまで豊富な形態から柔軟に選択可能 IBM の中核製品としての安定したロードマップ 44

45 IBM Application Integration Suite 45

46 IBM Application Integration Suite IIBの最上位エディションに位置づけられる IIBからのトレード アップライセンスも提供 API公開に必要な製品をワンストップで提供 IBM Integration Bus 広範な既存業務インターフェースをAPI化 API Connect : API公開に必要なセキュリティ 開発者管理 アプリ管理 トラフィック制御等のAPI 管理機能を提供 API ConnectはProfessional版となり DataPowerは同梱されない Salesforceとの連携用の部品も利用可能 IBM Application Integration Suite アプリ開発者 API Connect -セキュリティ -トラフィック制御 外部 取引先 APIマネージャー -ポリシー管理 -利用分析 社内 クライアントアプリ 開発者ポータル -API仕様の開示 -APIキーの管理 B2B バックエンド システム オンライン IBM Integration Bus - 既存システム間 連携の仲介 - 既存IFのAPI化 IoT モバイル Web 公開API Microgateway -API Gateway 内部API 既存IF SaaS 46

47 各コンポーネントの責務と製品のカバー範囲 API公開に必要となるコンポーネントは複数の製品の組合せで入手可能 IBM Application Integration Suite IBMの提供する製品 オファリング 機能コンポーネント IBM DataPower Gateway API Gateway IBM DataPower Micro Gateway Gateway Micro Gatewayの機能に加えて - 高度な認証 認可 - DMZに配置可能なセキュリティ - トラフィック制御 - APIのアセンブル - 認証 認可 API利用分析 API ポリシーの執行 APIのパススルー ESB 開発者ポータル -API仕様の開示 -APIキーの管理 APIマネージャー -API ポリシー管理 -利用分析 IBM Integration Bus - 既存IFのAPI化 - メディエーション IBM Integration Bus IBM Application Integration Suite IBM DataPower Gateway API Connect Professional / Essential API Connect Enterprise 47

48 ( 空白ページ ) 48

49 IBM API 製品採用事例のご紹介 49

50 API Connect活用事例 住信SBIネット銀行様 2016年3月25日発表 API接続によって残高照会や入出金明細照会などの銀行機能を提供するサービスを開始 第一弾として 株式会社マネーフォワードが提供するサービスとのAPI接続を開始 IBM API Connectを活用し よりセキュアな接続サービスを実現 提携先企業にログインID パスワードを 預ける必要がない 認証基盤 Oauth2.0準拠 による認証 IBM API Connectの活用により セキュアかつ容易にAPIを公開 アクセス制御や利用状況の分析も可能 住信SBIネット銀行プレスリリース API接続サービスの開始および株式会社マネーフォワードとの公式連携開始について ( 50

51 製造業のお客様 IBM Application Integration Suiteを採用 企業内連携基盤の強化に加え 将来の事業拡大を見据えた API 公開やクラウドとの連携に基盤を整備 ①社内システム連携基盤強化 ②将来を見据えた連携基盤 グローバル展開やM&Aに伴う連携増に対し 変更 追加 開発の工数と期間の短縮 取引先や社外との連携増加を想定し API公開やクラウ ド連携を検討 他社SaaS 社外開発者 社内開発者 パートナー MQLight/AMQP REST/HTTP SOAP/HTTP 選定理由 パフォーマンス 実機検証で実証 ハイブリッドクラウドへの対応力 API 公開 クラウド連携 ゲートウェイ 豊富な実績 SOAP/HTTP MQ File MQLight/AMQP REST/HTTP SOAP/HTTP Integration Bus REST/HTTP API Connect SOAP/HTTP DataPower Gateway M&A先 外部サービス Adapter SAP/PeopleSoft SOAP/HTTP Process ODBC/JDBC MQ / JMS File Data Apps Legacy CICS / IMS / Z DMZ 期待できる効果 システム連携に関わる工数 コストの大幅削減 新ビジネスや新業務の迅速な展開 外部サービスの活用が促進でき システム開発の 効率化が実現 多くの実績を持つ製品によって構成された 信頼性の高いオファリング 51

52 第一部 : まとめ Bi-Modal IT 問題の観点からの既存業務の API 化のメリット システムの利用状況が管理でき安全性と保守性が向上する 既存システムへのアクセス要望への対応を手間なく迅速に行える API 化におけるミドルウェアを活用した基盤の価値 API 基盤の実現を迅速化することができる 技術の変化に対応をミドルウェアに任せることができる API 化も含めたシステム連携 / 統合の分野は IBM の注力分野 継続的な投資により最新技術動向をリード ロードマップの安定性 52

53 第二部 基盤システムエンジニアのための API 公開第一歩 53

54 IIB の REST API サポート 54

55 IIB V10 REST API 連携機能概要 IIB における REST API サポート REST API 連携機能を強化し 既存システムの業務を API としてより簡単に公開可能に REST API 連携用の REST API アプリケーション を追加 Swagger 文書をインポートして REST API サービスを提供 スクラッチから REST API アプリケーションを生成することも可能 (Swagger 文書なしに新規作成 ) 外部 REST サービスを呼び出す REST Request ノードを追加 同期呼び出し (REST Request) 非同期呼び出し (REST AsyncRequest/REST AsyncResponse) の両方をサポート Application で Swagger を追加サポート JSON データを GUI(Graphical Mapping) でマッピング可能に REST API のオペレーションの実装を Mapping ノードで定義可能 API Connect との連携をサポート API Connect との連携により API の管理や API 呼び出しの制御を実現 API Connect への REST API 定義の Push 機能を提供 55

56 IIB V10 REST API 連携機能概要 IIB における REST API サポートの技術要素 REST API REST API アプリケーション REST API エディター REST ノード Swagger JSON セキュリティ対応 56

57 REST API API は相対パスによって識別される複数のリソースを含む リソースの例 基本パス 相対パス /customers /customers/12345 意味データベース内の全ての顧客情報顧客番号 12345の顧客情報 リソースと相対パス /customers API GET /customerdb/v1 POST /customers/12345/orders 顧客番号 12345の全ての注文情報 /customers/12345/orders/67890 顧客番号 12345の注文 #67890 /customers{customerid) PUT GET DELETE 各リソースは複数を操作を含み HTTP メソッドに関連づけられる リソース /customer/{customerid} に対する操作の例 HTTPメソッド操作 GET PUT DELETE getcustomer updatecustomer deletecustomer 各操作はHTTPボディの情報に加えてパラメーターを持つことができる 1) パス パラメーター URL のパスの一部として設定される 2) クエリー パラメーター key=valueの形式でパスの後に設定される 3) ヘッダー パラメーター HTTP 要求のヘッダーとして設定される 4) フォーム パラメーター 例 /customers/12345/orders/56789 例 /customers?min=5&max=20 例 Api-Client-Id : ff6e2c5d-42d f7f-d1e56da7f777 57

58 REST API アプリケーション REST API アプリケーション IIB V10 において REST API 実装に特化した アプリケーション が追加 REST API 公開を簡単に行う方法を提供 REST API の開発手法は 2 種類 Toolkit でスクラッチから REST API を作成 Toolkit に統合された REST API エディターでリソース モデル 操作などを定義し Swagger 文書を作成 Swagger 初心者にもわかりやすいインターフェースを提供 既存の Swagger 文書をインポートして REST API を作成 外部エディターを使用して Swagger 文書を作成 インポート可能な Swagger 文書の形式には制約がある ( 参照 : Swagger 文書に関する IIB の制約事項 ) Swagger 仕様に精通した人や IIB 開発者とは別の API 設計担当者が Swagger 文書を定義する場合に適する 58

59 REST API エディター REST API エディターを使用して API を実装 REST API 記述をダブルクリックで開き 定義の確認や設定を実施 IIB でスクラッチから REST API 開発する場合は REST API 記述の各セクションを順次定義していく Swagger 定義をインポートした場合は REST API 記述で定義内容を確認し 必要に応じて修正 REST API 記述の主な定義項目 Header セクションで REST API に関する一般情報を設定 Resources セクションで REST API の操作を定義 Model Definitions セクションで操作の要求 応答のスキーマ タイプに使用できる JSON データを定義 Error Handling でエラー ハンドラーを定義 Security セクションで HTTPS を設定 REST API 記述 59

60 REST ノード 外部の REST API 呼び出しのための REST ノードを提供 同期呼び出し 非同期呼び出しの用途に合わせて 以下の 3 つのノードを提供 RESTRequest ノード RESTAsyncRequest ノード RESTAsyncResponse ノード 既存システム IIB REST サービス MQ 呼び出し REST 呼び出し Swagger 文書を利用して REST ノードを構成 同期呼び出しの場合は 以下の方法で RESTRequest ノードを構成 REST API カタログから呼び出したいオペレーションを メッセージ フロー エディターにドラッグ & ドロップ パレットから RESTRequest ノードをメッセージ フロー エディターにドラッグ & ドロップ 使用する Swagger 文書の選択方法を指定 非同期呼び出しの場合は パレットから RESTAsyncRequest ノード RESTAsyncReponse ノードを追加 RESTAsyncRequest ノードで使用する Swagger 文書の選択方法を指定 60

61 Swagger REST API を記述するための仕様 JSON 形式の Swagger 文書で API を記述 リソース 操作 パラメーター HTTP 要求 応答のデータ モデルを表現する JSON スキーマ Web サービスにおける WSDL 文書の位置づけ IIB V10 では V2.0 がサポートされる Swagger 文書は一般に swagger.json という名前が付けられる REST API を記述 利用し 可視化するためのツールを含む Swagger UI API 文書をブラウザで表示し開発者にリファレンスとして提供 ブラウザ上から API のテスト可能 Swagger Editor YAML 形式で API を記述することで Swagger 文書を生成 Swagger Code Generator JSON 形式の Swagger 文書から各種言語向けにクライアント / サーバーのコードを生成 その他 Swagger-core プログラム ソース内のアノテーションの情報から Swagger 文書を生成 61

62 ( 参考 )Swagger 文書の例 swagger.json の例 ( 抜粋 ) { "swagger": "2.0", "info": { "title": "Staff Table API", "description": " 従業員テーブルへのアクセス用 API", "version": "1.0.0" }, "host": "localhost", "schemes": [ "http" ], "basepath": /StaffInfo/v1", "produces": [ "application/json" ], "paths": { "/staff/{id}": { "get": { "summary": " 従業員情報の取得 ", "description": "", "operationid": "getstaffdata", "parameters": [ { "name": "id", "in": "path", "description": " 従業員 ID.", "required": true, "type": "string" } ], "tags": [ "Staff" ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/staff" } }, "default": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/error" } } } } } }, ( 右へ続く ) API の情報の定義 - ホスト名 - スキーマ (HTTP/HTTPS 等 ) - 基本パス - Content-type 等 リソースと URL の定義 操作の定義 } ( 左からの続き ) JSON スキーマで API 内で利用されるオブジェクトを定義 "definitions": { "Staff": { "properties": { "staffid": { "type": "string", "description": " 従業員 ID" }, "lastchanged": { "type": "string", "format": "date-time", "description": " 最終更新日付 " }, "firstname": { "type": "string", "description": " 名前 " }, "lastname": { "type": "string", "description": " 苗字 " }, "mail": { "type": "string", "description": " メール アドレス " } } }, "Error": { "properties": { "code": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "fields": { "type": "string" } } } } 62

63 JSON JavaScript Object Notation (JSON) RFC 4627 で規定される軽量なデータ記述言語 JavaScript に限定したものではなく 様々なプログラミング言語で使用可能 JSON メッセージの構造は以下の 2 タイプ オブジェクト 名前と値のペア 配列 値のリスト オブジェクトと配列の組み合わせ ネストも可能 {"name": "John Smith", "age": 33} ["milk", "bread", "eggs"] IIB では JSON パーサー / ドメインを提供 提供は V から HTTP ノードに限らず 様々な入出力ノードで利用可能 Mapping ノードにて JSON スキーマ /Swagger 文書を基に JSON メッセージのマッピングが可能 メッセージ マップから JSON スキーマ /Swagger 文書を選択し マッピングを構成 JSON スキーマによる妥当性検査は未サポート 63

64 セキュリティ対応 REST API アプリケーションでは以下のセキュリティ対応をサポート HTTPS サポート REST API でも従来通り HTTPS 通信をサポート Basic 認証 REST API アプリケーションがリクエストを受信したタイミングでクライアントとの間で Basic 認証を行う ユーザー認証は 各種認証プロバイダーとの連携が可能 LDAP WS-Trust V1.3 準拠 STS TFIM など CORS 対応 他のドメインでホストされたコンテンツへのアクセスをブラウザに許可するための規格である Cross-Origin Resource Sharing(CORS) に対応 Web ページ HTTP リクエスト HTTP レスポンス w/web ページ Web サーバー A CORS 対応 IIB REST のサービスでよく利用される OAuth や OpenID Connect といった認証認可の仕組み ( 認可サーバーとしての機能 ) は IIB では未サポート 通常は フロントにゲートウェイ製品 (IBM API Connect や IBM DataPower Gateway など ) を配置し そのコンポーネットによって対応する 64

65 REST API 開発の流れ 65

66 REST API アプリケーション開発の流れ REST API アプリケーションの開発の流れ 1 REST API アプリケーションの作成 1-1.REST API アプリケーションを新規に作成 1-2.Swagger 文書をインポートして作成 事前にSwagger 文書を準備 2 REST API 記述にリソース モデル 操作の追加 3 4 REST APIの操作の実装 サブフローで操作を実装 エラー ハンドリングの実装 5 実行環境へのデプロイ 6 外部ツールを利用したテストの実施 66

67 1.REST API アプリケーションの作成 REST API アプリケーションを新規に作成する場合 ツールキットでスクラッチからの REST API を作成 New start by creating a REST API から REST API ウィザードを起動 REST API アプリケーション名をセットし Create a REST API and define resources and operations yourself を選択 REST アプリケーションと空の REST API 記述が作成される ウィザードを完了すると REST API エディターが起動空の REST API 記述が表示されるので ここで定義を追加していく 67

68 1.REST API アプリケーションの作成 Swagger 文書をインポートして作成する場合 Swagger 文書が事前にある場合は インポートして REST API を作成 Swagger V2.0 の制約に準拠し IIB の制約にかからないことを事前に確認 New start by creating a REST API から REST API ウィザードを起動 Import resources and operations defined in a Swagger document を選択し Swagger 文書を指定 68

69 1.REST API アプリケーションの作成 JSON ドキュメント (Swagger 文書 ) に定義された REST 操作がサマリーとして表示される インポートを完了すると REST API エディターが起動インポートした Swagger 文書に定義された操作やリソースの定義を確認 / 実装が可能 69

70 Swagger 文書に関する IIB の制約事項 Swagger 文書は JSON 形式 (.json) または YAML 形式 (.yaml/.yml) で保存する必要がある Swagger 文書の Operation Object の operationid フィールドに API 内でユニークな値を設定する必要がある 同一の基本パスを持つ REST API は統合サーバー上に複数デプロイすることはできない フォーム データ パラメーターは Swagger 文書では許容されているが パラメーターの解析処理には IIB のサポート対象外 JSON スキーマの $ref は 内部ファイル参照でのみサポートされる 70

71 2. リソース モデル 操作の追加 REST API エディターで REST API を定義 Header セクションでは REST API の概要情報を定義 REST API base URL は REST API の基本パス REST API のタイトルやバージョンの設定値は API Connect への PUSH の際に利用 Resources セクションでは REST API のリソースとそれに対する操作を定義 スクラッチから作成した場合は空定義 Create a new resource からリソースと操作を定義 Swagger 文書から生成した場合も リソースの追加 / 削除が可能 71

72 2. リソース モデル 操作の追加 リソースと操作の追加 Resources セクションの (Create a new resource) からリソースを追加 リソース パスとリソースに追加する操作を選択 72

73 2. リソース モデル 操作の追加 Resourcesに追加した操作に対し 入力パラメーターや要求 / 応答メッセージの定義などを追加 パラメーターの追加 照会パラメーターとヘッダー パラメーターはボタンで追加 / 削除可能 パス パラメーターはリソース パス指定時に定義し あとから名前やパラメーター タイプの変更は不可 パラメーターのデータ タイプやフォーマット 必須指定の定義はIIBでは妥当性チェックされない 要求 / 応答の追加 HTTPのステータス コードに応じて複数の応答を定義可能 73

74 モデルの追加 2. リソース モデル 操作の追加 Model Definitions セクションで JSON データのモデルを定義 データタイプ array 必須 ヌル許可 フォーマットを定義 Model Definitions セクションで JSON データのモデルを定義 操作の要求 応答の Schema type で定義したモデルを指定 定義したモデルを Resources セクションの要求 / 応答定義の Schema type で指定 74

75 3. 操作の実装 操作はサブフローとして実装 実装する操作の Create a subflow for the operation アイコンをクリックすると サブフロー実装用のメッセージ フロー エディターが起動 通常のフロー開発と同じ要領でノードを追加していく 実装していないオペレーションをクライアントが呼び出すと HTTP 501 Not Implemented が返される 75

76 3. 操作の実装 REST API 呼び出し時に Local Environment にセットされる情報 LocalEnvironment.REST.Input Method Operation Path URI Parameters LocalEnvironment.REST の例 用途 (0x :Name):REST = ( (0x :Name):Input = ( (0x :NameValue):Method = GET (CHARACTER) (0x :NameValue):Operation = 'getyen' (CHARACTER) (0x :NameValue):Path = /Exchangeraterest/v1/yen (CHARACTER) (0x :NameValue):URI = ' (CHARACTER) (0x :Name ):Parameters = ( (0x :NameValue):amount = '100' (CHARACTER) (0x :NameValue):currency = 'USD' (CHARACTER) ) LocalEnvironment 内の情報にアクセスする ESQL 例 リクエスターから呼び出した REST API のメソッド リクエスターから呼び出した REST API の操作 REST API の呼び出しパス REST API の呼び出し URI REST API 呼び出し時にセットした呼び出しパラメーターセットしたパラメーターがこの子ツリーとして生成される IF InputLocalEnvironment.REST.Input.Method = 'GET' THEN -- Executed only if the current operation was called using an HTTP GET. END IF; DECLARE logmessagepath CHARACTER 'Received request on path ' InputLocalEnvironment.REST.Input.Path; 76

77 3. 操作の実装 ( グラフィカル マッピング ) グラフィカル マッピングを使用して REST API 操作の実装も可能 マップ作成時に message map with input and output for REST API operation オプションを指定 REST API 記述内の JSON スキーマ定義を元に入出力データがセットされる Local Environment がマップに自動的に追加される 77

78 マップ入出力のメッセージ本体も REST API 記述から自動的にセットされる 入力メッセージ Swagger 文書で操作に対してリクエストとして定義された JSON 操作のリクエスト定義にデータ部がない場合は BLOB 出力メッセージ HTTP Status 200 の応答として定義された JSON(Status 200 の定義がない場合 デフォルトの応答または 1 つ目の応答定義 ) 操作の応答定義にデータ部がない場合は BLOB 画面例 ) 3. 操作の実装 ( グラフィカル マッピング ) 入力はデータ本体がないため BLOB 出力は REST API 定義から取得した JSON スキーマ定義 78

79 3. 操作の実装 ( グラフィカル マッピング ) REST API 記述にない JSON データをマップに使用する場合は マップに自動セットされたメッセージ アセンブリーを削除して 定義を追加 利用する JSON スキーマ定義は利用する REST API プロジェクトまたは共有ライブラリー内にファイルがあることが前提 マップ作成後にパラメーターやデータ定義を REST API 記述を変更すると 次回マップ起動時に変更が取り込まれる 既存の変換定義が無効になる可能性があるため マップの定義の見直しが必要 新たにデータ定義を追加する場合は マップの再作成が必要 79

80 4. エラーハンドリングの実装 REST API 記述の Error Handling でエラー処理を実装 3 つのタイプのエラー ハンドラーを提供 ハンドラーの種類 説明 Catch Timeout Failure 操作のサブフローでの処理時に例外がスローされ その例外がサブフロー内でキャッチされない場合に ルーティングされる 操作のサブフローが予期される時間内 (180 秒 ) にクライアントに応答を返さない場合に ルーティングされる Timeout エラー ハンドラーがクライアントに要求タイムアウトの旨を通知 ただし サブフローの処理がキャンセルされるわけではない クライアントからの要求処理中にエラーが発生し Catch や Timeout のエラー ハンドラーで処理されないケースでルーティングされる エラー ハンドラーもサブフローとして実装 エラー ハンドラーを実装しない場合 以下のデフォルトの動作となる ( 例 )Catch や Failure を実装しないと エラー発生時に HTTP 500 Internal Server Error が返される ( 例 )Timeout を実装しないと タイムアウト発生時に HTTP 504 Gateway Timeout が返される 80

81 4. エラーハンドリングの実装 REST API 記述の Error Handling セクションのリンクをクリックして各ハンドラーを実装 通常のフロー開発と同様にノードを配置してエラー処理を実装 ハンドラーを実装すると リンクの名称が Open に変わる 81

82 IIB の REST API 開発の考慮点 REST API の定義は REST API 記述を編集 REST API 記述をメッセージ フローとして確認することもできるが (.msgflow ファイルも作成される ) 編集は不可 REST API の操作やエラー ハンドラーはサブフローとして実装 REST API 記述から編集用のリンクをクリックすることでフロー エディターが起動 通常のフロー開発と同様に サブフローを定義 82

83 5. 実行環境へのデプロイ 通常のアプリケーションと同様に BAR ファイルを生成し デプロイ デプロイする REST API 定義を選択し Build and Save 注意点 複数の REST API を統合サーバーにデプロイする場合は異なる基本パスを指定する必要がある 83

84 5. 実行環境へのデプロイ デプロイした REST APIT を Web UI からの確認 呼び出すための URL や 呼び出し可能な操作が確認可能 呼び出し URL と REST API 定義の URL が表示 REST アプリケーションの API で操作の一覧が表示される どの操作が実装済みで 利用可能なのかを確認可能 84

85 6. テストの実施 REST の送受信が行える外部テストツールを利用して REST API のテストを実施 SwaggerUI を使用する例 WebUI で確認した REST API 定義の URL をセット テストする操作を開き 必要なパラメーターをセットして Try it out! を実行 85

86 6. テストの実施 確認可能な項目 実行した Curl コマンド リクエスト URL 応答電文 レスポンス コード 応答ヘッダー 86

87 IIB と API Connect の連携 87

88 API 公開の流れ APIConnect におけるロールと API 公開の流れ API 開発者 API を開発 API 製品管理者 API のテスト ステージング 公開 IIB から REST API Push により 上記ステップの一部 ( 外部公開のための API 定義の拡張 プランの作成 ステージング ) を実現 IIB での作業 APIC での作業 IIB で REST API を開発して PUSH 88

89 IIB から API Connect への連携 IIB にデプロイされている REST API を API Connect に対して Push し API Connect 経由による API 外部公開を容易に実現 IIB から API Connect への Push API Connect への Push 方法は 3 つ 1. Webユーザーインターフェースを使用して1つ以上のAPIをデプロイ 2. mqsipushapisコマンドを使用して1つ以上のapiをデプロイ 3. IBM Integration Toolkitを使用して 単体のAPIをデプロイ Toolkitを使用した場合は API 作成まで実施 Web UIやコマンドを使用した場合 製品も作成され ステージングの有無も選択可能 ステージングしたい場合は 対象のカタログ ( サンドボックスが前提 ) を指定 Push 時には事前に統合サーバーに REST API をデプロイ済みであることが前提 Push 後に API Connect 側でセキュリティ要件の追加や 製品の作成 API の追加 / 修正 ステージング 公開を実施 89

90 Web UI を使用した API Push Web ユーザーインターフェースから REST API を Push X.XX.XX.XX 統合サーバーのメニューから Push REST APIs to IBM API Connect を選択 API Connect の接続情報やユーザー情報を設定 90

91 Web UI を使用した API Push Push する API を選択して Push to IBM API Connect 組織の選択 タイトル 名前 バージョンの指定 ステージングする場合は カタログを選択 Push されると API Connect 上に API 製品が作成され さらにカタログ Sandbox にステージングされた旨のメッセージが表示される 91

92 コマンドを使用した API Push IIB コンソールで mqsipushapis コマンドを実行して REST API を Push コマンドのパラメーター等については以下を参照 コマンド例 mqsipushapis integrationnodespec -e integrationservername -t apiconnecthost -g apiconnectport -u apiconnectuser -a apiconnectpassword -o apiconnectorganization コマンド実行例 C: Program Files IBM IIB >mqsipushapis IIB e EG01 -t 9.XX.XX.XXX -g 443 -u -a passw0rd -o "Naomi's Provider Org" -c Sandbox -r DemoAPI -d DemoAPI -s k DemoAPI BIP9357I: Successfully replaced API 'DemoAPI' in IBM API Connect. BIP9358I: Successfully created Product 'DemoAPI' and added API 'DemoAPI' to it in IBM API Connect. BIP9360I: Successfully staged Product 'DemoAPI' to Catalog 'Sandbox' for Organization 'Naomi's Provider Org' in IBM API Connect. BIP8071I: コマンドが完了しました 92

93 ツールキットを使用した API Push ツールキットから REST API を Push 統合サーバーにデプロイされた REST API( DemoAPI) を右クリック Push to IBM API Connect API Connect の接続情報や ユーザー ID/ パスワードを設定 93

94 ツールキットを使用した API Push Push 対象となる組織を選択し Finish をクリックすると API が Push され API Connect に定義が作成される 94

95 デモ 95

96 API Connect との連携デモ IIB で作成した REST API を APIC に Push するステップをご説明 IIB での作業 APIC での作業 IIB で REST API を開発して PUSH 96

97 デモ環境のご説明 使用する環境 API Connect アプリ開発者 DMZ 開発者ポータル サーバー環境 クライアントアプリ 公開API B2B モバイル Web SaaS 実行環境 -API仕様の開示 -APIキーの管理 外部 取引先 社内 IoT Trusted Zone 公開API API Gateway Data Power Micro Gateway APIマネージャー IBM Integration Bus -ポリシー管理 -利用分析 -APIの実行 内部API 内部API -APIを保護 制御 -高度なｾｷｭﾘﾃｨｰ Compute -APIの実行 PC環境 Developer Toolkit API デザイナー - LoopBack - マイクロGateway - CLI 開発環境 API開発者 97

98 IIB メッセージ フローのシナリオ REST API のプロバイダーとなるメッセージ フローを開発 IIB が既存 MQ アプリケーションの API Wrapper として動作 REST/JSON で連携 MQ/ 固定長で連携 Swagger UI を利用 HTTP GET の Path パラメーター IIB ( 社員番号 ) 既存システム REST クライアント メッセージ フロー MQ アプリケーション HTTP 受信 HTTP 応答 変換 変換 MQPUT MQGET 社員情報照会システム { "EmployeeInfo": { "EmployeeName": ISE Hanako", "Organization": "ISE.OpenMiddleware" }} プロトコル変換フォーマット変換 Ise Hanako ISE.OpenMiddleware ( 社員名 所属組織 ) 98

99 IIB メッセージ フローの開発の流れ 1. REST API アプリケーションの作成 2. 既存システムと連携するための メッセージ モデルの準備 3. リソースの定義 4. モデルの定義 5. 操作の定義 6. 実行環境へのデプロイ 7. テストの実施 8. API Connect への Push 99

100 ( 空白ページ ) 100

101 API Connect による API 公開 101

102 IIBとAPI Connectの連携 IIBで作成したAPIをAPI Connectで公開する際の機能と手順について説明 API Connect アプリ開発者 DMZ 開発者ポータル Trusted Zone -API仕様の開示 -APIキーの管理 外部 取引先 社内 APIマネージャー クライアントアプリ 公開API IoT B2B モバイル Web SaaS 実行環境 公開API API Gateway Data Power Micro Gateway -APIの実行 内部API 内部API -APIを保護 制御 -高度なｾｷｭﾘﾃｨｰ Developer Toolkit IBM Integration Bus -ポリシー管理 -利用分析 API デザイナー - LoopBack - マイクロGateway - CLI Compute -APIの実行 開発環境 API開発者 102

103 API Connect の機能 103

104 API仕様の定義 API追加メニュー 公開するAPI仕様を定義する方法 APIマネージャーの ドラフト メニューの API タブで定義 GUIでスクラッチから定義 WSDLのインポート Swagger OpenAPI 文書のインポート IIBからPush IIB上で定義されていたインターフェース仕様がそのまま引き継がれて設定される APIマネージャーの ドラフト メニューの 設計 タブ 仕様はSwagger文書のYAML形式で確認可能 ソース タブにて表示 API仕様の追加設定やカスタマイズが可能 ソース YAML 設計 タブにて設定 例 認証 基本認証 OAuth APIキー HTTPS パス メソッド パラメーター 要求/応答メッセージのフォーマット Swagger2.0 記述 WSDL サービス レジストリー IIB import import discovery push 自動生成 10 4

105 製品化とレート制限 製品 APIをパッケージングしてステージング 公開する単位 APIは複数の製品に所属可能 開発者ポータル上での可視性 参照 利用させるアプリ開発者 を指定する プラン 製品の中に最低1つがデフォルトで作成され 複数のプランを製品の中に定義できる プランの中に含めるAPIとレート制限を指定 アプリ開発者が利用登録 配信登録 する単位 レート制限 レート制限はプランの中で指定可能 プラン全体 個々のAPIの操作の両レベルで柔軟に指定可能 プランの設定例 製品 製品 顧客サービス ライトプラン API API ベーシックプラン API API API レート制限 レート制限 105

106 アクセス制御と流量制御 アプリケーション単位での API へのアクセス制御と流量制御が可能 設定方法 あらかじめプロバイダー側で 製品 プランを作成しておく 各アプリケーションに API キーを発行する プランに対して各アプリケーションのサブスクライブを設定する 利用できる API( パス ) の種類とレート制限 ( 単位時間あたりの利用回数 ) はプランへのサブスクライブにより決定 API キーの発行とプランへのサブスクライブの設定方法 開発者ポータルからアプリケーション開発者が実施 または API マネージャーから API 管理者が実施 API 提供側 API 利用側アプリA APIキー AAAA API 提供側 プラチナプラン : レート制限 100 回 / 分 API-A レート制限 : 100 回 / 分 API-B レート制限 : 100 回 / 分 サブスクライブ状況アプリA アプリB APIキー BBBB API-C レート制限 : 50 回 / 分ゴールドプラン : レート制限 50 回 / 分 API-A レート制限 : 50 回 / 分 サブスクライブ状況アプリB アプリC APIキー CCCC API-B レート制限 : 50 回 / 分 アプリ C アプリD APIキー DDDD レギュラープラン : レート制限 10 回 / 分 API-A レート制限 : 10 回 / 分 サブスクライブ状況アプリD 106

107 変換と処理のカスタマイズ ゲートウェイで実施する処理をカスタマイズできる機能 API マネージャーの ドラフト メニューの API タブから該当 API を選択し アセンブル タブにて設定 最低限バックエンドの API サービスの呼び出しを設定する 追加で必要な処理を柔軟に追加できる ( メッセージ変換 XML-JSON 変換 処理分岐など ) 独自の処理をユーザー定義ポリシーとして作成 利用することも可能 サンプルのユーザー定義ポリシーは GitHub からダウンロードして再利用可能 アセンブル機能の例 外部 API の呼び出し XML/JSON メッセージ変換 XML,JSON データの Validation レスポンス変換 変数変換 ( マッピング ) 変数の取得 生成 エラー制御 複数 API のマッシュアップ レスポンス キャッシング エラーレスポンスのカスタマイズ 複数の API と連携してマッシュアップ JavaScript 実行 XSLT 実行 プロトコル変換 分析ログ出力内容変更 Operation-switch If Throw アセンブル機能 パレット ( ビルトイン ポリシー ) ドラッグ & ドロップで配置 アセンブリー フロー 各ポリシーをクリックして詳細を指定 キャンバス プロパティー シート 107

108 ライフサイクル管理とバージョン管理 API Connectでは 製品とAPIのバージョン管理機能を提供 APIと製品それぞれにバージョンを持ち APIはバージョンを指定して製品に含める APIを修正した場合は新しいバージョンのAPIとして定義し 新しいバージョンの製品に含めて公開できる 古いバージョンの製品の公開を停止したい場合 サブスクライブしているアプリ開発者に事前通知を行ったうえで 新しいバージョンの製品にサブスクリプショ ンのマイグレーションを強制的に行える 初期状態 製品A V1 API-B V1 製品A V1 製品A V1 API-A V1 アプリA 数ヵ月後 数週間後 API-A V1 プ ラ ン アプリA API-C V1 API-B V1 プ ラ ン アプリA API-C V1 API-Aをバージョンアップ してV2としたので 製品A のV2として公開 アプリB 製品A V2 製品A V2 API-A V2 API-A V2 API-B V1 API-C V1 あるタイミングで製品AのV１の API-A V1 公開を停止したい場合 アプリ プ 開発者に事前通知した上で 新 API-B V1 ラ しいバージョンの製品にサブス ン クリプションのマイグレーショ ンを強制的に行える API-C V1 プ ラ ン アプリB API-B V1 プ ラ ン API-C V1 108

109 開発者ポータル APIを利用するアプリケーション開発者向けのポータル機能 主な提供機能 API仕様表示 サンプルコード表示 テストツール アプリケーション登録 管理 クライアントIDの発行 管理 分析 ブ ログ フォーラム レーティング ソーシャル連携 カタログ 製品を公開するスペース 単位で開発者ポータルの有効/無効を指定可能 デフォ ルトは無効 開発者ポータルのLook & Feelは柔軟にカスタマイズ可能 独自の開発者ポータルを作成するためのAPIも提供 プランの選択画面例 開発者ポータル画面例 ブログ機能 フォーラム機能 - APIの仕様 - プランの表示 選択 - FAQの表示 利用可能なプラン サポート機能 チケット発行 言語ごとのサンプルコード curl Ruby Python PHP Java Node Go Swift プランの選 択ボタン APIキー クライアントID の発行例 リクエスト レスポンス のサンプル表示 APIのテスト実行 APIキー クライア ントID 109

110 分析機能 APIの利用状況の分析機能 APIゲートウェイを通過するAPIトラフィックの情報は APIマネージャーに非同期で送信 され分析データとして蓄積される 課金のベースとなるデータ取得や APIのトレンド分析が可能 ダッシュボード画面 蓄積された分析データを APIマネージャーのダッシュボード上で分析可能 デフォルトのフィルター定義の中から選択するとダッシュボードに表示される 表示するフィルター定義を自由に定義可能 レイアウトや大きさをカスタマイズ可能 分析ダッシュボード表示例 分析データの保存 分析データは APIを利用してエクスポート可能 分析 データ ③分析データは APIを利用し てデータとしてエクスポート可能 ②蓄積された分析データを 分析ダッ シュボード上で分析することが可能 APIマネージャー ①APIゲートウェイを通過するAPIトラ フィックの情報は APIマネージャーに非 同期で送信される IoT API B2B Web モバイル SaaS クライアント アプリ API ゲートウェイ 内部API API管理者 110

111 API Connect による API 公開ステップ 111

112 API 公開の流れ APIConnect におけるロールと API 公開の流れ API 開発者 API を開発 API 製品管理者 API のテスト ステージング 公開 IIB から REST API Push により 上記ステップの一部 ( 外部公開のための API 定義の拡張 プランの作成 ステージング ) を実現 IIB での作業 APIC での作業 IIB で REST API を開発して PUSH 112

113 API 記述の作成 API マネージャーから Push された API の設定を確認する IIB から Push すると API マネージャー上で自動的に API 定義が作成されているので確認する API マネージャーの ドラフト メニューの API タブから該当 API を選択し 設計 タブで定義 追加で必要な設定やカスタマイズを行う 認証の追加や パスの変更 追加 パラメーターや要求 応答メッセージのフォーマット変更など Push された API の名前をクリックして詳細を表示し 追加で必要な設定やカスタマイズを実施 113

114 API 記述の作成 バックエンドの API を呼び出す設定を アセンブル タブで確認 正しい URL が入力されていることを確認する 追加で必要な処理があれば追加する ( メッセージ変換 XML-JSON 変換 処理分岐など ) アセンブルでは Proxy が実装されているので URL の内容を確認 114

115 製品 プランの作成 API マネージャーの ドラフト メニューの 製品 タブで設定 IIB の Web UI やコマンドから Push する場合は 製品の作成とステージングまで行うこともできる 製品がすでに作成されている場合は 既存の製品の設定の確認 編集を行い 製品がない場合は新たに製品を作成する プランをカスタマイズして プランに含める API を変えたり レート制限の設定を行う プランに含める API を変えたり レート制限の設定を行う 115

116 API テスト API マネージャー上で API のテストを実施可能 APIマネージャーの ドラフト メニューの API タブから該当 APIを選択し アセンブル タブのからテスト画面を表示 ボタン テスト画面を表示 操作やパラメーターを確認して 呼び出し をクリックすると API のテスト呼び出しが行える カタログや API が含まれる製品名を確認して 次へ 116

117 製品のステージング API マネージャーの ドラフト メニューの 製品 タブから該当の製品を選択 右上のボタンをクリックすると ステージング先のカタログが表示される ステージングするカタログ ( デフォルトでは Sandbox ) を選択してステージングを実行 ステージングが完了すると メッセージが上部に表示される 該当の製品をクリック ステージング ステージングが完了するとメッセージが表示される 117

118 製品の公開 API マネージャーの ダッシュボード メニューから 該当のカタログ ( デフォルトでは Sandbox ) を選択すると そのカタログ上の製品一覧が表示される 製品をクリックすると その製品に含まれる API とプラン プランにサブスクライブしているサブスクライバー ( アプリケーション ) の数などが表示される ステージングした製品の状態は ステージング済み というステータスとなっているので 右のボタンから公開を選択して公開する 該当の製品をクリックするとその製品の情報が表示される ステージング済み のステータスになっている 開発者ポータル上での表示制御とサブスクライブできるアプリ開発者について指定をし 公開 をクリック 公開をクリック 公開が完了するとメッセージが表示される 118

119 開発者ポータルからの利用 アプリ開発者は開発者ポータルにログインして API キーの発行 プランへのサブスクライブ API のテスト実行などを実施可能 アプリケーション メニューから アプリケーションを登録すると API キー ( クライアント ID) とシークレットが自動発行される API 製品 メニューから製品名を選択し プランへのサブスクライブが可能 アプリケーションの登録を行うと API キー ( クライアント ID) とシークレットが発行される API のテスト実行が可能 プランへのサブスクライブは プランの一覧から 配信登録 をクリック 登録しているアプリケーションが表示されるので チェックを入れて 配信登録 をクリック 119

120 ( 空白ページ ) 120

121 デモ 121

122 API Connect との連携デモ IIB で作成した REST API を API Connect を利用して公開するステップについて説明 IIB での作業 APIC での作業 IIB で REST API を開発して PUSH 122

123 デモ環境のご説明 使用する環境 API Connect アプリ開発者 DMZ 開発者ポータル サーバー環境 クライアントアプリ 公開API B2B モバイル Web SaaS 実行環境 -API仕様の開示 -APIキーの管理 外部 取引先 社内 IoT Trusted Zone 公開API API Gateway Data Power Micro Gateway APIマネージャー IBM Integration Bus -ポリシー管理 -利用分析 -APIの実行 内部API 内部API -APIを保護 制御 -高度なｾｷｭﾘﾃｨｰ Compute -APIの実行 PC環境 Developer Toolkit API デザイナー - LoopBack - マイクロGateway - CLI 開発環境 API開発者 123

124 API 公開までの流れ 1. API 記述の作成 ( 確認 ) 2. 製品 プランの作成 3. APIテスト 4. 製品のステージング 5. 製品の公開 6. 開発者ポータルからの利用 124