¿Cómo funciona la autenticación con tu clave API?

Para cada llamada a través de https necesitas una clave API. La clave determina la cuenta en la que trabajas: no hay un nombre de usuario independiente ni un token que caduque.

Enviar tu clave

La autenticación se realiza mediante basic auth. Introduce tu clave como nombre de usuario y deja la contraseña en blanco. En curl, pon dos puntos después de la clave; de lo contrario, curl te pedirá una contraseña de todos modos.

Puedes leer cómo funciona esto con el botón «Try it» de esta documentación en Probar la API con Try it.

curl https://api.laposta.nl/v2/list \
  -u TU_CLAVE_API:

Si no envías una clave válida, la API devuelve un mensaje de error 401:

{
  "error": {
    "type": "invalid_request",
    "message": "No valid API-key provided"
  }
}

Crear una clave

Puedes crear claves en tu cuenta, en «Conectar». Para saber cómo hacerlo exactamente, qué información de la clave puedes seguir viendo después y cuántas claves puedes crear, consulta Crear una clave API.

Uso seguro de tu clave

Una clave da acceso a todos los datos de la cuenta, así que trátala como una contraseña.

En su lugar, utiliza una variable de entorno o el gestor de secretos de tu proveedor de alojamiento y haz que las llamadas se realicen desde tu propio servidor. Si quieres hacer pruebas, utiliza una lista aparte en tu propia cuenta. Hazlo sobre todo con los endpoints que crean o eliminan datos. Por lo general, no es posible crear una cuenta gratuita de prueba aparte: ver Una cuenta gratuita por organización.

Artículos relacionados