Autenticación

Puedes configurar parámetros de autenticación para permitir que los usuarios usen sus keys de API reales.

​

Habilitar la autenticación

Puedes añadir un método de autenticación en tu docs.json para habilitarla globalmente en todas las páginas o configurarla de forma individual por página.

El método de autenticación definido en una página reemplazará al global si ambos están establecidos.

​

Token Bearer

docs.json

"api": {
    "mdx": {
      "auth": {
        "method": "bearer"
      }
    }
}

​

Autenticación básica

docs.json

"api": {
    "mdx": {
      "auth": {
        "method": "basic"
      }
    }
}

​

API key

docs.json

"api": {
    "mdx": {
      "auth": {
        "method": "key",
        "name": "x-api-key"
      }
    }
}

​

Ninguno

El método de autenticación “none” es útil para deshabilitar la autenticación en un endpoint específico después de establecer un valor predeterminado en docs.json.

Page Metadata

---
title: "Your page title"
authMethod: "none"
---