Autenticación de la API

Los mecanismos de autenticación se comparten entre todas las APIs de DTZ. Por lo tanto, todos los mecanismos descritos aquí están disponibles para todas las APIs.

Los datos de autenticación pueden transmitirse a través de los siguientes campos:

  • token bearer
  • basado en cookies
  • clave API
  • autenticación básica

Autenticación

La autenticación es gestionada por el servicio DTZ Identity.

OAuth 2.0 y OpenID Connect: Para una integración completa de OAuth y OIDC, consulta la detallada Guía de OAuth en la sección Identity.

Posibles escenarios de inicio de sesión:

WebUI

https://identity.dtz.rocks/login/

Inicio de sesión DTZ Identity

Con el encabezado HTTP Apikey

Para autenticarse con una clave API, la clave API debe enviarse como el campo de encabezado X-API-KEY.

Aquí hay un ejemplo de comando curl:

curl -X GET "https://api.dtz.rocks/v1/me" -H "X-API-KEY: YOUR_API_KEY"

Con token Bearer HTTP

Para autenticarse con un token bearer, el token debe enviarse en el campo de encabezado Authorization: Bearer YOUR_BEARER_TOKEN.

Aquí un ejemplo de cómo obtener un token bearer:

> POST https://identity.dtz.rocks/api/2021-02-21/token/auth
> Content-Type: application/json
>
> {
>  "username": "user",
>  "password": "password"
> }

< {
<   "access_token": "eyJhb...",
<   "scope": "00000000-0000-0000-0000-000000000000",
<   "token_type": "Bearer",
<   "expires_in": 86400
< }

Aquí hay un ejemplo de cómo usar el token bearer:

curl -X GET "https://identity.dtz.rocks/api/2021-02-21/me" -H "Authorization: Bearer {bearer token}"

> GET https://identity.dtz.rocks/api/2021-02-21/me
> Authorization: Bearer eyJhb...

< {
<   "roles": [ ]
< }

Con encabezado HTTP de autenticación básica

Aquí hay un comando curl de ejemplo para usar autenticación básica y acceder a la API de DTZ.

curl -X GET -u 'apikey:apikey-1234' "https://identity.dtz.rocks/api/2021-02-21/me"

Como alternativa, o cuando la autenticación bearer regular no esté disponible, el servicio también acepta tokens bearer mediante el esquema de autenticación básica.

curl -X GET -u 'bearer:{bearer-token}' "https://identity.dtz.rocks/api/2021-02-21/me"

También está permitido usar el token JWT como cookie. El token debe pasarse como cookie con el nombre dtz-auth.

Con parámetro GET

A veces, los proveedores de terceros no permiten configurar ningún tipo de autenticación. Para ese caso, una clave API también puede pasarse como parámetro GET con el nombre apiKey.