Saltar al contenido principal
GET
Obtener la anulación de instrucciones de un proveedor
Devuelve las instrucciones de conexión personalizadas que has almacenado para este proveedor: la lectura enfocada que carga un editor antes de guardar. Un proveedor sin personalización responde 404. Usa Retrieve a Provider Overlay, que nunca devuelve 404, cuando quieras la capa sin importar si existe una personalización.
Un campo que no personalizas está ausente: no es null ni una lista vacía. Ausente significa “conserva el valor del catálogo de Yuno”; presente y vacío significa “reemplázalo por nada”.

Parámetros de ruta

string
requerido
ID de proveedor del catálogo de Yuno en UPPER_SNAKE_CASE. No distingue mayúsculas de minúsculas: se normaliza a mayúsculas.

Respuesta

string
Id del proveedor del catálogo de Yuno, normalizado a mayúsculas.
object[]
Pasos de conexión que reemplazan los del catálogo. Cada paso acepta step, text, text_link, link, type, has_sub_instructions, sub_instructions_type y sub_instructions (anidados hasta 3 niveles). text y text_link son un string simple o un mapa de idiomas como {"EN": "...", "ES": "..."}.
object[]
Pasos de configuración agrupados que reemplazan los del catálogo. Cada grupo acepta title, order, instructions_type y instructions (la misma forma de paso).
string
Enlace de documentación que reemplaza el del catálogo. Siempre https.
string
Nombre para mostrar que reemplaza el del catálogo. Solo los proveedores propiedad de Yuno pueden llevar uno.
string
Marca de tiempo ISO 8601: cuándo se escribió la personalización por primera vez.
string
Marca de tiempo ISO 8601: cuándo se escribió la personalización por última vez.
string
El usuario del dashboard que la creó. Las personalizaciones escritas mediante esta API llevan el valor centinela de ceros, que significa “escritas mediante la API” y no por una persona en el Dashboard.
string
El usuario del dashboard que la actualizó por última vez, con la misma regla del valor centinela que created_by.

Errores

Autorizaciones

PUBLIC-API-KEY
string
header
predeterminado:<Your PUBLIC-API-KEY>
requerido
PRIVATE-SECRET-KEY
string
header
predeterminado:<Your PRIVATE-SECRET-KEY>
requerido

Parámetros de ruta

provider_id
string
requerido

ID del proveedor del catálogo de Yuno en UPPER_SNAKE_CASE. No distingue mayúsculas de minúsculas; se normaliza a mayúsculas.

Ejemplo:

"STRIPE"

Respuesta

La anulación almacenada.

provider_id
string

ID del proveedor del catálogo de Yuno, UPPER_SNAKE_CASE.

Ejemplo:

"STRIPE"

instructions
object[]

Pasos de conexión que reemplazan los del catálogo.

setup_instructions
object[]

Pasos de configuración agrupados que reemplazan los del catálogo.

more_info_url
string<uri>

Enlace a la documentación que reemplaza al del catálogo, cuando se personaliza. Siempre https.

Ejemplo:

"https://docs.example.com/stripe"

name
string

Nombre visible que reemplaza al del catálogo, cuando se personaliza. Solo los proveedores propiedad de Yuno pueden tener uno.

Ejemplo:

"Acme Risk"

created_at
string<date-time>
read-only

Cuándo se escribió la anulación por primera vez.

Ejemplo:

"2026-09-02T13:54:13Z"

updated_at
string<date-time>
read-only

Cuándo se escribió la anulación por última vez.

Ejemplo:

"2026-09-02T13:54:13Z"

created_by
string<uuid>
read-only

El usuario del Dashboard que la creó. Las anulaciones escritas mediante esta API llevan el valor centinela con todos ceros 00000000-0000-0000-0000-000000000000, que significa "escrito mediante la API" y no por una persona en el Dashboard.

Ejemplo:

"00000000-0000-0000-0000-000000000000"

updated_by
string<uuid>
read-only

El usuario del Dashboard que la actualizó por última vez, con la misma regla del valor centinela que created_by.

Ejemplo:

"00000000-0000-0000-0000-000000000000"