認証 - Swipelux

すべての Swipelux API キーは、保護されたバックエンドに保管してください。ブラウザーコード、モバイルアプリケーションのバンドル、クライアントに公開される構成ファイルにキーを配置しないでください。

API キーを送信する

共通のベース URL https://platform.swipelux.com を使用し、キーを X-API-Key ヘッダーで送信します。

export API_BASE='https://platform.swipelux.com'
export SWIPELUX_API_KEY='replace-with-your-api-key'

curl --request GET \
  "${API_BASE}/v3/capabilities" \
  --header "X-API-Key: ${SWIPELUX_API_KEY}"

GET /v3/capabilities は、キーが有効であり、バックエンドが API に到達できることを確認します。

サンドボックスと本番

サンドボックスと本番は同じ API ホストを使用します。API キーによって環境が選択されます。環境の選択はデプロイ構成に保持してください。本番デプロイがサンドボックスのキーにフォールバックしてはならず、サンドボックスのデプロイに本番の認証情報が渡ってはいけません。

認証情報を安全に保管する

サンドボックスと本番のキーは、別々のシークレットマネージャーエントリーに保管してください。それぞれのバックエンドデプロイには、必要なエントリーへのアクセスのみを付与します。キーをソース管理、ログ、アナリティクス、サポート用スクリーンショット、エラーレスポンスに含めないでください。漏えいが疑われる場合はキーをローテーションしてください。次に、サンドボックステストを構成するか、クイックスタートを始めてください。