API Authentication

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

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

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

Autenticación

La autenticación es manejada por el servicio de identidad DTZ.

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

Escenarios posibles de inicio de sesión:

WebUI

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

DTZ Identity Login

Con encabezado HTTP Apikey

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

Aquí un ejemplo de comando curl:

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

Con token HTTP Bearer

Para autenticarse con un token bearer, el token tiene que pasarse como 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í 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 Basic Auth

Aquí un ejemplo de comando curl 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 a través del 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, proveedores terceros no permiten establecer autenticación. Para ese caso, una clave API también puede pasarse como parámetro GET con el nombre apiKey.