多くの友人は、最初にプロダクト マネージャーになった時点ですでにその業務に非常に熟練していましたが、依然として開発者からの不満を耳にすることは避けられませんでした。マネージャーは「インターフェースは？」と困惑した表情で表現できますか、とだけ言いました。それは何ですか？ページの機能をすでにドキュメントに詳細に記載していませんか?
実際、システム レベルでは、コピーライティングやボタンなどの目に見えるコンテンツに加えて、コンテンツの下に多くの論理チェーン ( APIと呼ばれることが多いインターフェイス) も隠されています。この記事は、API の基本知識とプロダクト マネージャーの具体的なビジネス シナリオに基づいて API をより深く理解して使用し、開発者とより効率的に協力できるようにするのに役立ちます。
APIとは何ですか?
API (アプリケーション プログラム インターフェイス) は、さまざまなアプリケーションが相互に通信できるようにする一連の定義済みルールです。これは、システム間のデータ転送を処理する中間層として機能し、企業がアプリケーション データと機能を外部のサードパーティ開発者、ビジネス パートナー、社内部門に公開できるようにします。
画像ソース: CSDN@tbprice
API がどのように機能するかは、実際には簡単に理解できます。 API の仕組みを WeChat 決済を通じて説明すると、簡単に理解できます。テイクアウトを注文すると、システムは「WeChat 支払いを使用する」または他のタイプのサードパーティの支払い方法を使用するように求めます。この支払い機能は API に依存して完了します。支払いボタンをクリックすると、情報を取得するための API 呼び出しが行われます (リクエストとも呼ばれます)。リクエストは、API の URI (Uniform Resource Identifier) を介してアプリケーションから Web サーバーに処理されます。URI には、リクエスト動詞、ヘッダー、および場合によってはリクエスト本文が含まれます。
製品 Web ページから有効なリクエストを受信した後、API は外部プログラムまたは Web サーバー、つまりサードパーティの支払いシステムを呼び出します。サーバーは、要求された情報を含む応答を API に送信します。 API は、最初に要求を行ったアプリケーション (この場合は製品 Web サイト) にデータを転送します。データ転送は使用する Web サービスによって異なりますが、リクエストとレスポンスはすべて API を通じて行われます。これらの転送はユーザー インターフェイスには表示されません。つまり、API はコンピューターまたはアプリケーション内でデータを交換し、ユーザーには滑らかでシームレスな接続のように見えます。
API はどのように分類されますか?
通信シナリオが変化すると、API の分類次元も異なります。
- API プロバイダーに応じて、自社 API、サードパーティ API (例: ID 認証、SMS サービス、決済サービス、AI ラージ モデルなど) に分類されます。
- APIの技術属性に応じて分類：システムAPI（例：キャッシュ、タイミング、通知、モニタリングなど）、ビジネスAPI（会員API、製品API、コンテンツAPI、トランザクションAPIなど）、プラットフォームAPI（個人ログインAPIなど） 、検索API、AI顧客サービス）APIなど）。
- APIの呼び出し方法により、同期API、非同期APIに分かれます。
- API の粒度に応じて分割されます: サービス API (例: Meituan Takeaway API、Taobao Mall API、JD Express API など)、機能 API (例:ショート チェーン API、ロケーション API、エンタープライズ認証 APIなど)。
- APIが外部に公開されているかどうかによって、内部API、オープンAPIに分かれます。
プロダクト マネージャーはどのようなシナリオで API を設計する必要がありますか?
- インターネット ベースのアプリケーション (SPA アプリケーション、APP アプリケーション、小規模プログラム、スマート デバイス アプリケーションなど) を開発する場合、技術アーキテクチャは基本的にクライアント サーバー モデルになります。現時点では、サーバーは基本的に API であり、プロダクト マネージャーです。ビジネスについて説明するだけで済みます。
- 技術的なインターフェースを上流および下流のユーザーに提供する場合、基本的に API の形式で提供されます。このとき、プロダクト マネージャーは API を設計および定義する必要があります。
- エンタープライズ サービスが収益化され、API として提供される場合、プロダクト マネージャーは API の設計、API の定義、API の価格設定などを行う必要があります。
プロダクト マネージャーはどのようなシナリオでサードパーティ API を使用しますか?
企業がデジタル システムを開発する場合、コスト要因、データまたはリソースの保有要因、技術的能力要因などにより、すべてのサービスを自社で開発することは不可能であり、また、オープンソース コードを多用して構築することもできません。 -party API は避けられない選択となっています。
ログインなどの一般的な基本シナリオ:アプリケーションを設計する場合、最も基本的な機能はユーザーのログイン機能です。ユーザーは各ソフトウェアに個別のアカウントを登録する必要はなく、WeChat、QQ、Alipay などのアカウントを使用してログインできます。アプリケーションプログラム。同様のシナリオには、KYC 認証、シングル サインオン、セキュリティ管理、資金回収と支払い、ソーシャル共有、ユーザー コミュニケーションなどが含まれます。
旅行予約などのプラットフォーム リソースを使用するシナリオ: 主要な旅行プラットフォーム ソフトウェアの基本機能は、フライトとホテルの情報を集約し、日付ごとに異なる価格を表示することです。通常、このデータは数千の Web サイトやホームページから取得され、このサービスも API を通じて完了します。同様のシナリオには、速達や物流、テイクアウト プラットフォーム、いくつかの主要な電子商取引プラットフォームなどが含まれます。企業はサードパーティ API を使用する必要があります。
AI ラージ モデルなどのサードパーティの技術機能を使用するシナリオ: AI ラージ モデルは、 24 年ぶりに新たな人気となっており、ほとんどの企業は自社で開発できず、主に AI を使用することになります。同様のシナリオには、クラウド コンピューティング テクノロジー、ブロックチェーン テクノロジー、ビッグ データ テクノロジー、ストレージ テクノロジーなど も含まれます。
CRM などのエンタープライズ SaaS アプリケーションを使用する: CRM (顧客関係管理ツール) などのプラットフォームには、メッセージング、ソーシャル メディア、電子メール アプリケーションなど、企業がすでに使用しているアプリケーションと統合できるようにする多くの組み込み API が含まれていることがよくあります。これにより、販売およびマーケティングのタスクを実行するためにさまざまなアプリケーションを切り替えるのにかかる時間が大幅に短縮されます。同様のシナリオには、金融 SaaS、人間用 SaaS、オフィス SaaS、マーケティング SaaS などが含まれます。
プロダクト マネージャーはどのようにして優れた API 製品ドキュメントを作成するのでしょうか?
製品 PRD の主な読者は、バックエンド開発 (RD)、フロントエンド開発 (FE)、インタラクション デザイナー (UI、UE)、およびテスト (QA) です。彼らは、PRD で完了する必要がある作業目標を取得します。を作成し、基本計画の設計に使用します。
前回の記事では、API の知識を学び、開発者とコミュニケーションするための言語を習得しました。今度は、開発者がニーズを理解できるように、この知識をニーズの説明に変換する必要があります。
以下は具体的なケースです。私たちが電子商取引プラットフォームのプロダクト マネージャーであり、ユーザーの注文を作成する機能を実装するための新しい API を設計する必要があるとします。 API 製品ドキュメントを作成するときは、次の点を考慮する必要があります。
- インターフェース機能の説明: まず、この API の機能、つまりユーザー注文の作成が何であるかを明確にする必要があります。入力パラメータ、出力結果などを含め、ドキュメント内で関数を詳細に説明します。
- パラメータの説明: 注文作成機能には、ユーザー情報、商品情報、支払い情報などのパラメータが含まれる場合があります。文書内のすべての可能なパラメータをリストし、意味、タイプ、各パラメータが必須かどうかを説明します。
- リクエストの例: 開発者が API を呼び出して注文作成機能を実装する方法を示す、いくつかの具体的なリクエストの例を提供します。開発者が明確に理解できるように、例ではさまざまな状況でのパラメータの組み合わせを取り上げる必要があります。
- 戻り結果: API呼び出し後にどのような戻り結果が得られるか(成功、失敗など)を記述します。成功した場合は、返された注文情報の詳細を説明する必要があります。失敗した場合は、失敗の理由を説明する必要があります。
- エラー コードの定義: 開発者が API を呼び出すときにエラー コードに基づいて問題をすぐに特定できるように、考えられるエラー コードとその意味を定義します。
- セキュリティに関する考慮事項: ユーザーのプライバシーや支払いなどの機密情報が含まれる API の場合、セキュリティを考慮する必要があります。 HTTPSプロトコルの使用やパラメータの暗号化など、ユーザー情報のセキュリティを確保する方法を文書で説明します。
上記の詳細な説明を通じて、製品マネージャーは明確で完全な API 製品ドキュメントを作成し、開発者に要件を効果的に伝え、必要な機能を正しく実装できることを保証できます。
API について開発チームとどのようにコミュニケーションをとればよいですか?
統一基準
プロジェクトにはコミュニケーションが必須です。開発パートナーと連絡を取る前に、プロダクト マネージャーは、より適切な変更とフォローアップを実現するために、標準と方法を統一することに注意を払う必要があります。
統合プラットフォーム
iPaaS プラットフォームや API ゲートウェイなどの最新のプラットフォームの助けを借りて、企業はまず基礎となる技術レベルで実装の一貫性を確立し、プラットフォームの機能を活用し、技術的な複雑さを無視してビジネス自体に集中します。
統合ツール
技術担当者が API 設計を実行する場合、API 設計ツールを使用すると、製品マネージャー、開発者、テスターが共通のビューで通信、プログラミング、アップグレード、保守を行うことができます。
「Qing Yu Nian 2」の海賊版リソースが npm にアップロードされたため、npmmirror は unpkg サービスを停止せざるを 得なくなりました。 周宏儀: すべての製品をオープンソースにすることを提案します 。ここで time.sleep(6) はどのような役割を果たしますか? ライナスは「ドッグフードを食べる」ことに最も積極的！ 新しい iPad Pro は 12GB のメモリ チップを使用していますが、8GB のメモリを搭載していると主張しています。People 's Daily Online は、オフィス ソフトウェアのマトリョーシカ スタイルの充電についてレビューしています。「セット」を積極的に解決することによってのみ、 Flutter 3.22 と Dart 3.4 のリリース が可能になります。 Vue3 の新しい開発パラダイム、「ref/reactive」、「ref.value」不要 MySQL 8.4 LTS 中国語マニュアルリリース: データベース管理の新しい領域の習得に役立ちます Tongyi Qianwen GPT-4 レベルのメイン モデルの価格が値下げされました97%、1元と200万トークン