Probar la conectividad con Núclea para un participante

curl --request POST \
  --url https://slc.sandbox.lerian.net/v1/participants/{participantIspb}/test-connectivity \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://slc.sandbox.lerian.net/v1/participants/{participantIspb}/test-connectivity"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://slc.sandbox.lerian.net/v1/participants/{participantIspb}/test-connectivity', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://slc.sandbox.lerian.net/v1/participants/{participantIspb}/test-connectivity",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://slc.sandbox.lerian.net/v1/participants/{participantIspb}/test-connectivity"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://slc.sandbox.lerian.net/v1/participants/{participantIspb}/test-connectivity")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "cdConnection": {
    "status": "<string>",
    "latencyMs": 123
  },
  "nucleaApi": {
    "status": "<string>",
    "latencyMs": 123
  },
  "participantId": "<string>",
  "rsfnConnection": {
    "status": "<string>",
    "latencyMs": 123
  },
  "certificateExpiresAt": "<string>",
  "certificateValid": true
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

Probar la conectividad con Núclea para un participante

Envía una sonda de conectividad adecuada para el rol por el canal REST (AGEN001 para el rol DOMICILE_IF y AGEN999 para los demás roles de participante) e informa el eco de ida y vuelta y la latencia en el estado del canal nucleaApi. El parámetro de ruta es el ISPB de 8 dígitos del participante, NO el UUID de participante que usan las operaciones hermanas de /v1/participants. Devuelve 404 cuando el ISPB no corresponde a un participante del catálogo del tenant. RBAC: connectivity:test (admin). Los canales cdConnection y rsfnConnection informan NOT_CONFIGURED porque los transportes administrados de archivos y de mensajería no están disponibles actualmente. Un transporte con el circuit breaker abierto devuelve un 503 reintentable.

POST

participants

{participantIspb}

test-connectivity

Probar la conectividad con Núclea para un participante

curl --request POST \
  --url https://slc.sandbox.lerian.net/v1/participants/{participantIspb}/test-connectivity \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://slc.sandbox.lerian.net/v1/participants/{participantIspb}/test-connectivity"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://slc.sandbox.lerian.net/v1/participants/{participantIspb}/test-connectivity', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://slc.sandbox.lerian.net/v1/participants/{participantIspb}/test-connectivity",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://slc.sandbox.lerian.net/v1/participants/{participantIspb}/test-connectivity"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://slc.sandbox.lerian.net/v1/participants/{participantIspb}/test-connectivity")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "cdConnection": {
    "status": "<string>",
    "latencyMs": 123
  },
  "nucleaApi": {
    "status": "<string>",
    "latencyMs": 123
  },
  "participantId": "<string>",
  "rsfnConnection": {
    "status": "<string>",
    "latencyMs": 123
  },
  "certificateExpiresAt": "<string>",
  "certificateValid": true
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

Autorizaciones

Authorization

string

header

requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

participantIspb

string

requerido

Participant ISPB (8 digits). A non-conforming value is rejected with 400.

Ejemplo:

"12345678"

Respuesta

cdConnection

object

requerido

managed file-transfer channel status (not yet configured: NOT_CONFIGURED).

Show child attributes

nucleaApi

object

requerido

Núclea REST-channel connectivity probe outcome: status is OK when the probe echo round-trips and DEGRADED otherwise. The probe sent is selected by the participant role: AGEN001 for the DOMICILE_IF (IF Domicílio) role, AGEN999 for other roles.

Show child attributes

participantId

string

requerido

Participant id (8-digit ISPB).

Ejemplo:

"12345678"

rsfnConnection

object

requerido

message-broker channel status (not yet configured: NOT_CONFIGURED).

Show child attributes

certificateExpiresAt

string

Signing-certificate expiry (RFC3339 UTC); not populated when certificate management is not configured.

Ejemplo:

"2027-06-15T00:00:00Z"

certificateValid

boolean

Whether the signing certificate is valid (not populated when certificate management is not configured).

Ejemplo:

true

⌘I

Pix — Lerian SPI (mensajería nativa)

Pix — JD (interfaz, directo)

Pix — BTG (interfaz, indirecto)

TED — Lerian SPB (mensajería nativa)

TED — JD (interfaz)

Boletos — BTG (interfaz)

Lerian SILOC (mensajería nativa)

Lerian SLC (mensajería nativa)

Lerian STA (mensajería nativa)

Lerian SISBAJUD (mensajería nativa)

Lerian Consignado (mensajería nativa)

Probar la conectividad con Núclea para un participante

Autorizaciones

Parámetros de ruta

Respuesta