Developers API & Widget
API Reference
ES

OAuth

Configura el flujo OAuth

El usuario se autentica en Wealth Reader, vuelve a tu redirect_uri con un code y tú lo canjeas por el mismo JSON que el callback del iframe.

Usa este camino si no puedes embeber el iframe (app nativa o un flujo por redirección). Si tu aplicación web puede montar un iframe, usa iframe frontend en su lugar.

Camino rápido

  1. Autoriza el dominio con access_type=oauth.
  2. Genera nonce, state y code_verifier. Calcula challenge_code. Codifica wr_conf en hexadecimal. Guarda nonce y code_verifier.
  3. Redirige al usuario a https://oauth.wealthreader.com/oauth2/ con esos parámetros.
  4. Recibe GET en tu redirect_uri con nonce y code.
  5. Haz POST a https://oauth.wealthreader.com/token/ y obtén el payload del banco.

1. Autorizar el dominio

El domain debe ser la misma URL que usarás como redirect_uri y como url_callback.

curl --location 'https://api.wealthreader.com/domains/' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'method=add' \
  --data-urlencode 'api_key=TU_API_KEY' \
  --data-urlencode 'domain=https://example.com/oauth/success.php' \
  --data-urlencode 'url_callback=https://example.com/oauth/success.php' \
  --data-urlencode 'access_type=oauth' \
  --data-urlencode 'tokenize=1'

También puedes dar de alta el dominio desde el área de clientes eligiendo integración OAuth.

2. Generar los valores del desafío

Genera tres cadenas aleatorias de 41 caracteres alfanuméricos (A-Za-z0-9) y conviértelas a hexadecimal (bin2hex). Cada valor hexadecimal tiene 82 caracteres.

Valor Cómo se obtiene Se envía en
redirect_uri Tu URL de retorno, la misma que autorizaste query y POST /token/
nonce 41 chars → hex query; vuelve en el GET
state 41 chars → hex query
code_verifier 41 chars → hex solo POST /token/ (no va en la query)
challenge_code SHA-256 de code_verifier (hex digest) query, como challenge_code
wr_conf JSON de configuración del selector → hex query

wr_conf admite los mismos campos que el iframe frontend. Ejemplo antes de pasar a hexadecimal:

{
  "operation_id": "op_a1b2c3d4e5f6",
  "entities_to_display": [],
  "wait_full_response": true
}

Hexadecimal de ese JSON:

7b226f7065726174696f6e5f6964223a226f705f613162326333643465356636222c22656e7469746965735f746f5f646973706c6179223a5b5d2c22776169745f66756c6c5f726573706f6e7365223a747275657d

Convertir wr_conf a hexadecimal no genera nonce, state ni code_verifier. Esos tres valores se crean aparte y tienes que persistirlos (asociados al nonce) hasta el POST /token/.

Ejemplo en PHP, equivalente al que usamos internamente:

function randomAlnum($length)
{
    $alphabet = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
    $value = '';
    for ($i = 0; $i < $length; $i++) {
        $value .= $alphabet[random_int(0, strlen($alphabet) - 1)];
    }
    return $value;
}

$nonce = bin2hex(randomAlnum(41));
$state = bin2hex(randomAlnum(41));
$code_verifier = bin2hex(randomAlnum(41));
$challenge_code = hash('sha256', $code_verifier);

$wr_conf = bin2hex(json_encode([
    'operation_id' => 'op_a1b2c3d4e5f6',
    'entities_to_display' => [],
    'wait_full_response' => true,
]));

3. Redirigir al usuario

Construye la query y redirige. Ejemplo con valores coherentes entre sí:

https://oauth.wealthreader.com/oauth2/?challenge_code=c725133644f703a5f069a09583fa981eb5b8820071a4450f8d47ff8b1c6a879a
&code_challenge_method=S256
&redirect_uri=https://example.com/oauth/success.php
&response_type=code
&state=73684148464b3778795873626d724e62734749724336685a7a687854336c317934524f516831316a45
&nonce=696d6a716d4a47746d714e52656562496f61786468765a30335a4b4a646d6c546c5339654e42586573
&wr_conf=7b226f7065726174696f6e5f6964223a226f705f613162326333643465356636222c22656e7469746965735f746f5f646973706c6179223a5b5d2c22776169745f66756c6c5f726573706f6e7365223a747275657d

El usuario ve el selector de bancos, se autentica y, al terminar, Wealth Reader lo devuelve a tu redirect_uri.

4. Recibir el GET en redirect_uri

https://example.com/oauth/success.php?nonce=696d6a716d4a47746d714e52656562496f61786468765a30335a4b4a646d6c546c5339654e42586573
&code=1234567890abcdef1234567890abcdef1234567890a

Usa el nonce para recuperar el code_verifier que guardaste en el paso 2. Si el nonce no es el que emitiste, descarta la petición.

5. Completar el desafío

curl --location --request POST 'https://oauth.wealthreader.com/token/' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'grant_type=authorization_code' \
  --data-urlencode 'redirect_uri=https://example.com/oauth/success.php' \
  --data-urlencode 'code=1234567890abcdef1234567890abcdef1234567890a' \
  --data-urlencode 'code_verifier=6634413364504337675230375a624671644f644d42414241303037737374684f494877477649723433'
Campo Valor
grant_type authorization_code
redirect_uri Exactamente el mismo del paso 3
code El del GET
code_verifier El hexadecimal que generaste en el paso 2

Si los valores coinciden, la respuesta es el JSON del banco (mismo esquema que el callback del iframe): success, payload y statistics (operation_id, token, code).

Guarda token y code si más adelante vas a refrescar con POST https://api.wealthreader.com/entities/.

Código de ejemplo

Hay un ejemplo en Java (JBang / Java 17) que genera los parámetros y completa el desafío:

Descargar ejemplo en Java (ZIP)

Si necesitas el mismo flujo en otro lenguaje, escríbenos a support@wealthreader.com.

Última actualización