基礎から分かる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管理
この記事の著者
関連記事
新着ホワイトペーパー PR
-
製品資料
[株式会社MatrixFlow] 「物流リソース最適化」ガイド:人員・配車・傭車を出庫依頼の確定前に決めきる -
製品資料
[株式会社キーエンス] なぜRPA導入は頓挫する? シナリオ作成の壁を乗り越える解決策とは -
製品資料
[株式会社セールスフォース・ジャパン] 「CRMは設計と無関係」は本当か? PLMとの融合で実現する高速開発 -
事例
[日本ヒューレット・パッカード合同会社] AIエージェントの時代にどう備える? 「新たな働き手」を支える3要素とは -
製品資料
[日本ヒューレット・パッカード合同会社] “横並びの自動化”から脱却、AI活用で生産性と競争力を高める秘訣
こんなメディアも見られています
TechTargetジャパンに関連する情報をお探しであれば、こちらのメディアもお役に立てるかもしれません。
ベンダーコンテンツ PR
From Informa TechTarget
SpecialPR
アクセスランキング
-
1
法務と開発者で「言葉が通じない」問題 トヨタやソニーが語るOSS管理の真実
-
2
なぜ「全社配布Copilot」は使われないのか? 失敗に学ぶAI定着
-
3
なぜ「Gemini 4 Argon」は出遅れたのか? Googleが狙う“逆転のシナリオ”
-
4
ChatGPTは“検索しまくり”でGeminiは“淡泊”? データが明かすAIの裏側
-
5
損保ジャパンはなぜ「COBOL」を捨てなかったのか? 脱メインフレームの真相
-
6
【漫画付き】ひとり情シス協会が明かす、RAG導入でしくじる企業「2つの共通点」
-
7
AI時代のITインフラ戦略とは? 販売代理店が知っておきたい最新トレンド
-
8
情シスの約8割が転職や退職を意識 調査で分かった“辞めたくなる最大の理由”
-
9
人間のせいでAIエージェントの生産性が上がらない
-
10
「IBM i(AS/400)はクローズドなシステム」という誤解 DXに寄与する一歩
ホワイトペーパーランキング PR
-
1
不審メールの経路や見せ方に変化? 2026年夏の3事例から見えた動向と対処方法
-
2
家庭用Wi-Fiルーターの業務利用は危険? 避けるべき理由と具体的な対策
-
3
Microsoft 365を安全に運用 うっかりミスやサイバー攻撃に備えるデータ保護術
-
4
財務部門がAIを最大限に活用する方法 無駄のない戦略的リーダーシップへの道
-
5
LLMが兵器化? 元FBI高官が鳴らす警鐘とセキュリティツール統合のポイント
-
6
「オンプレミス回帰」せざるを得ない“合理的な理由”
-
7
なぜRPA導入は頓挫する? シナリオ作成の壁を乗り越える解決策とは
-
8
生成AIを開発に導入しても効果が見えない? 実証実験で分かった成果と課題
-
9
経産省DX指針から読み解く、受発注業務デジタル化ロードマップ
-
10
HDDを使わない「SSDオンリー」が無謀なのはなぜ?
TechTargetジャパン SNS
インフォメーション
注目情報をチェック
TechTargetジャパンをフォロー