基礎から分かるAPI管理【第2回】
APIとは何か? Web APIとの違い、利用者のタスクを解説(2/2 ページ)
API活用に必要なタスク
ここまでAPIおよびWeb APIの概要について述べたが、ここからはWeb APIの活用、特に昨今よく使われているRESTful APIを活用する際に必要なタスクについて説明する。
API仕様の確認
API活用に当たり、まず必要になるタスクは、API提供者が提供するAPIの仕様の確認および試験的な利用だ。
・リクエストフォーマット、パラメーターの確認
API提供者が公開しているAPIレファレンスには、HTTPメソッドやURIだけでなく、APIコール時に受け入れ可能なリクエストフォーマットおよびパラメーターが記載されている。リクエストフォーマットはクエリストリング(URIの末尾にパラメーターを記載するフォーマット)なのかJSONなのか、XMLなのかといったことを調査する。昨今では、音声ファイルや画像ファイルといったバイナリファイルが利用可能なAPIも提供されているため、音声ファイルのビットレート、画像ファイルのピクセル数も考慮する必要がある。
リクエストパラメーター(JSONデータやXMLデータに記載するキーやタグ名)には必須パラメーターとオプションパラメーターが指定されていることがあるので、これらも考慮する。
・レスポンスの確認
リクエストと同様の観点で、正常時および異常時のレスポンスフォーマットとパラメーターについてAPIレファレンスで確認する。加えて正常時、異常時のHTTPステータスコードを確認し、APIコールが正常に完了したのか、異常時にどのような異常が発生したのかを判別可能にしておく。
・認証方式の確認
APIの利用に当たり、認証が不要なAPIと必要なAPIが存在する。APIの認証として、主に3つの認証方式(Basic方式、APIキー方式、OAuth方式)が存在するため、どの認証方式を取るのかを確認する。
これらの認証方式は、HTTPリクエストヘッダやリクエストボディー、URIのパラメーターに組み込む認証情報に違いがある。Basic方式は、ユーザー名とパスワードを直接組み込む。APIキー方式で組み込むのは、API提供者が払い出した「APIキー」と呼ばれる認証情報だ。OAuth方式は、認証用サーバから「アクセストークン」と呼ばれる認証情報を取得し、そのアクセストークンを組み込む。
・API利用が有償かどうかの確認
APIの中には、有償のAPIが存在する。有償APIの利用を検討している場合、課金方式の確認が必要となる。課金方式には、コール数課金(APIコール数ごとに利用料がかかる)やトラフィック課金(APIコール時に送出したデータ量に応じた利用料がかかる)などが存在する。
・APIテストツールを利用したAPIの試験的な利用
ある程度、API仕様を把握したらAPIの試験的な利用を始める。簡易なAPIであれば、Webブラウザ機能で十分だ。リクエストパラメーターが多くかつ複雑だったり、複数のAPIを組み合わせたりしたい場合はWebブラウザでは実現が難しいため、APIテストツールを利用するのが適切である。
自社サービスに他社APIを組み込む
API仕様の確認が完了し、APIの試験的な利用でも問題がない場合、いよいよ自社サービスへのAPIの組み込みを実施する。このタイミングにおいても、幾つか考慮する点が存在する。
・API提供者からのSDK/クライアントライブラリ提供の有無の確認
自社サービスを実現しているアプリケーションからAPIコールするためには、自前でHTTP/HTTPSでAPIをコールするモジュールを作り込む、もしくはAPI提供者のSDK(ソフトウェア開発キット)/クライアントライブラリを利用する方法が存在する。後者のSDK/クライアントライブラリを利用することで開発を効率化できるため、もし存在すれば積極的に活用する。
・API提供者のAPIライフサイクルの確認
API提供者の戦略のためにAPI仕様が変更され、自社サービスに不具合が発生することがある。こうした事態を防ぐためには、APIライフサイクルをAPI提供者に確認することは必須だ。API仕様の変更予定があれば、猶予期間の設定や新旧APIの並行提供を打診しておく必要がある。
・API提供者のAPI利用不可時における対処法の整理
自社サービスにAPI提供者のAPIを組み込むことは、そのAPIに自社サービスのサービスレベルが依存することに他ならない。そのため、API提供者のAPIが利用不可になる場合のアプリケーションレベルでの対処(APIが利用不可でも他機能は正常動作する)や、ドキュメントレベル(規約・免責事項)での対処を実施しておく必要がある。
岡野隆也(おかの たかや)
元データベースエンジニア。これまで、システム障害時の技術サポート、データ分析、クラウドサービスの開発、セキュリティ関連システムの開発など、さまざまな業務に従事。現在はSoE領域のビジネス拡大に向け新技術の検証・評価、PoC実施に従事中。国内外問わず旅行に行くのが趣味。まだ南半球に行ったことがないため、近年中の実現を画策している。
Copyright © ITmedia, Inc. All Rights Reserved.
基礎から分かるAPI管理
この記事の著者
関連記事
こんなメディアも見られています
TechTargetジャパンに関連する情報をお探しであれば、こちらのメディアもお役に立てるかもしれません。
ベンダーコンテンツ PR
From Informa TechTarget
SpecialPR
アクセスランキング
-
1
「Excel至上主義」の終わらせ方 丸2日の手作業地獄から情シスと現場を救うには
-
2
「Microsoft 365のセキュリティ運用」に関するアンケート
-
3
取手市がVDIと決別した理由 更改費用「4倍超」を約1.7倍に圧縮
-
4
急増する「AIはこう言ってる」マン 判断を狂わせる「AI忖度」を防ぐには?
-
5
221人調査で分かった「情シス最大のストレス」は?
-
6
「Salesforceのテスト自動化ツール」に関するアンケート
-
7
IT製品の導入に関するアンケート「サーバ&ストレージ」編
-
8
「データストレージの活用方法」に関するアンケート
-
9
「AI時代の統合基盤・エンタープライズAI管理」に関するアンケート
-
10
自宅のWi-Fiが「遅い」「途切れる」本当の原因は? Dellが推奨する鉄則
ホワイトペーパーランキング PR
-
1
年収2000万「クラウドセキュリティのプロ」になれる資格とは
-
2
セキュリティソフトをすり抜ける標的型攻撃メール、不審メールの見破り方とは?
-
3
Windows Updateの通信集中で回線が逼迫、ネットワーク刷新事例に学ぶ解決策
-
4
財務を戦略的組織へ進化させるAI活用術、4つの主要な障壁と解消方法
-
5
「NAS」「SAN」「DAS」は何が違う? いまさら聞けないストレージの基礎
-
6
“あのファイル転送”で暗躍するノーウェアランサム
-
7
標的型攻撃メールを見破るには? サンプル文面を例に傾向を解説
-
8
商用利用の安全性を確保し大量のコンテンツを高速で生成する、AI活用の秘訣
-
9
マンガで解説、1日で生成AI環境を構築できるワークショップの中身とは?
-
10
Dark AIが台頭する時代の新発想、「より高度なAIで対抗する」具体的方法とは?
TechTargetジャパン SNS
インフォメーション
注目情報をチェック
TechTargetジャパンをフォロー