ApidogでAPIドキュメントのアクセス制御を簡単にする5つの方法

APIドキュメントを作成し、公開の準備ができたとき、重要な疑問が浮かびます。誰がそれを閲覧できるべきでしょうか？

ドキュメントは完全に公開されるべきでしょうか？それとも社内チームに限定されるべきでしょうか？もしかしたら、外部パートナーにはアクセスが必要かもしれませんが、誰でもアクセスできるわけではありません。

各シナリオのためにドキュメントの別バージョンを作成することは、時間と効率の面で非効率的です。実際には、アクセス要件は非常に具体的であることが多く、特定の部署だけが見るべきだったり、パートナーが自社の企業ネットワーク内からのみアクセスできるべきだったりする場合があります。

幸いなことに、Apidogはこれらのすべてのニーズを満たす複数のアクセス制御オプションを提供しています。ドキュメントサイトを公開する際、ユースケースに合ったアクセス制御方法を選択するだけです。

1. 公開: 誰でも閲覧可能

もしAPIが製品の公開APIのように一般公開されている場合、アクセス制御を「公開」に設定するだけです。リンクを知っている人なら誰でもドキュメントを閲覧できます。

プロのヒント: Apidogには、開発者がAPIを閲覧・発見できるマーケットプレイス形式のプラットフォーム、APIハブもあります。そこにドキュメントを公開することで、可視性と採用率を高めることができます。

ドキュメントを完全に公開したくないが、複雑な設定も避けたい場合があります。パスワード保護は簡単な解決策です。パスワードを設定すれば、それを知っている人だけがドキュメントにアクセスできます。

設定は簡単です:

最適: API設計のレビューをパートナーに依頼するなど、短期または一時的な共有に適しています。その後は、パスワードを更新するか、ドキュメントの公開を停止するだけです。シンプルでクリーンです。

ただし、注意してください: パスワードは意図せず共有される可能性があります。より厳格な制御が必要な場合は、他のオプションを検討してください。

チームやパートナーが固定されたオフィス拠点にいる場合、IP許可リストが最良の選択肢となるかもしれません。

仕組みは次のとおりです:

ドキュメントのファイアウォールと考えてください。

最適:

単一のIPまたはIP範囲全体を設定できます。

ボーナス: Apidogのチーム設定（エンタープライズプランが必要）で、チームプロジェクトアクセスに対してもIP許可リストを有効にできます。有効にすると、許可されたIPからのユーザーのみが社内プロジェクトにアクセスできます。

パスワードが漏洩したり、IPが頻繁に変わることを懸念していますか？メール許可リストは、柔軟で安全な代替手段です。

チームやパートナーのメールアドレスを許可リストに追加するだけです。ユーザーはワンタイムメール認証コードを介してドキュメントにアクセスできるようになります。

ワイルドカードもサポートしています。例えば、*@apidog.comと設定すると、会社のドメインを持つすべてのユーザーがドキュメントにアクセスできるようになります。

利点:

上記のどの方法もニーズに合わない場合、より高度なオプションとしてカスタムログインページがあります。これにより、独自の認証システムを接続してアクセスを制御できます。

仕組みは次のとおりです:

このアプローチにより、ビジネスニーズに合わせて正確に権限を定義できます。多少の開発は必要ですが、複雑なアクセス制御ニーズを持つ企業に最適です。

カスタムログインページの実装については、ヘルプドキュメントをご確認ください。

非常に多くのオプションがあるため、あなたは疑問に思うかもしれません。どれを選べばいいのでしょうか？

それはあなたのユースケースによります:

ヒント: 複数の方法を組み合わせることができます。例えば:

Apidogでは、それぞれ独自のアクセス制御と調整されたAPIエンドポイントを持つ複数のドキュメントサイトを公開できます。これにより、異なるオーディエンスが必要なものだけを見ることができ、それ以上でもそれ以下でもありません。

button