https://d226lax1qjow5r.cloudfront.net/blog/blogposts/what-makes-an-api-product-successful-dr/What-Makes-a-Great-API-Product_1200x600.png

何がAPI製品を成功させるのか?

最終更新日 May 18, 2021

所要時間:1 分

ユーザーのために楽しいAPIを作ることに時間を費やすだけでなく、他のAPIメーカーとのイベントにも参加しています。

10月には APItheDocsに参加し、いくつかのセッションを発表した。私たちがとても楽しめたトークのひとつは、"What Makes an API Product Successful? Anthony Rouxであった。

もし本当に熱心なら、講演のビデオを見ることができる:

Anthonyの講演では、APIを製品として成功させるために重要だと思われる一連のポイント(全部で8つ)が取り上げられた。そのうちのいくつかは、私たちがすでに行っている仕事と本当に共鳴するものであり、また他のいくつかは、私たちがぜひ改善したいと思うことについて考える材料を与えてくれた。全体として、それは素晴らしいポイントのミックスだった。

オープンであること

見込み客がアプリケーションで作業するために必要なすべてのドキュメントにアクセスできるようにすることで、見込み客が自社のAPIをソリューションとして選択する自信を高めることができる。

私たちのAPIリファレンス・ドキュメントはすべてOpenAPI仕様書としても提供されており、開発者の皆様が私たちの提供するサービスを検討する際にも、また実際に構築したアプリケーションの統合や保守を行う際にも、より分かりやすくなることを願っています。

ステータスページ、価格設定、利用規約を "オープンが要求される "カテゴリーに含めることは、アマデウスの仕事にとって明らかに重要であり、私たちにとってもそうである。

ドキュメンテーション

私たちは、受賞歴*のあるドキュメンテーションと開発者ポータルを誇りに思っています。 https://developer.nexmo.com/私たちは、APIリファレンスドキュメントと、様々な技術スタックのための多くのコードスニペット、ハイレベルガイド、そして特定のアプリケーションをステップバイステップで作業するための長編チュートリアルを組み合わせています。

*私たちは本当に受賞歴があります!ここで私たちを見つけることができるかどうか見てください https://pronovix.com/blog/devportal-awards-2019

オンボーディング

ユーザーができるだけ早く探索を始められるように、登録プロセスを非常に簡単かつ迅速にする。

アンソニーの「データ収集はできるだけ延期した方がいい」というアドバイスはとても貴重だった。また、唯一無二の存在である cbettaの「APIを頻繁に使うように登録するように!」というアドバイスも思い出された。

サインアッププロセスに目を配り、ユーザーがどのように体験しているかを意識することは、デベロッパーエクスペリエンスの重要な要素である。

アンソニーの "3つのルール "で、目標達成のためのオンボーディング・エクスペリエンスを:

  • APIを理解するための3秒

  • アカウント作成に30秒

  • 最初のAPIコールに3分

すべてのAPIがこのことを念頭に置いて作られていればいいのだが!

例とデモ

オープンソースと実行可能なコードサンプルを用意することに重点を置いていて、とても良かった。

私たちは、実行可能なコードサンプルのコレクションを保持し、GitHub上の "本物の "コードへのリンクとともに、必要に応じて開発者向けドキュメントにそれらを取り込みます。これにより、コード・サンプル・コレクションを維持することができ、また、開発者が必要であれば、そのコードのコンテキストを確認することができます。

Screenshot of code snippets on the Nexmo Developer Portal

SDK

SDKを持つことは、APIと統合する開発者の作業を加速させる。

我々と同じように、アマデウスはOpenAPIフォーマットでAPIの詳細な説明をしており、アンソニーは自動生成されたSDKと、職人的で手作りの楽しいソリューションのバランスについて素晴らしいアドバイスをくれた。私たちの6つの(そして非公式の 非公式の7つ目のSDKを持つ私は、このセクションに耳を傾け、同じような問題を解決している他の人たちの経験を聞くことができました。

無料トライアル

すべてのAPIユーザーに限定的な無料トライアルを提供することは、開発者があなたのサービスを調査するのを助ける本当に良い方法だ。

例えば、Accountがこのフェーズにある場合、少数のテスト用電話番号の使用しか許可しないなどです。開発者は、プロトタイプを作るだけなら会社のクレジットカードを使えないことが多いので、ちょっとした実験のためにカードを持つことが必須条件にならないようにしましょう!

価格設定モデル

価格モデルはシンプルにし、支払い方法を選べるようにする。都度払いは、特に小規模から始めて成長する可能性のある顧客には効果的だ。

サポート

最後のセクションは、私たちの身近な話題である「サポート」である。

ユーザーに対して、サポートや一般的な連絡方法について明確にしてください。

アンソニーが強く勧めたのは、例えばサポートのために公共のプラットフォームを使うことだった、 スタック・オーバーフローのように、あるユーザーの質問に答えると、他のユーザーも同じ答えを見つけることができる。

また、FAQを利用し、積極的に更新することも勧めている。これは、明確なフィードバックの仕組みのようなあらゆる種類の文書化機能とともに、ユーザーの体験がどのようにうまくいっているかを理解するのに本当に役立つ。

私たちの技術に関するイベントに参加したり、単に顧客と交流したりすることは、チームとして本当に重要なことです。

この講演は、APItheDocsのセッションの中でも間違いなく私のお気に入りのひとつだ!

シェア:

https://a.storyblok.com/f/270183/250x250/e3d3b71060/lornajane.png
Lorna Mitchellヴォネージの卒業生

ローナはブログ癖のあるソフトウェア・エンジニアだ。彼女は言葉とコードを同等に扱おうとしている。