Base de conocimientos BCdiplomaBase de conocimientos BCdiploma
Guía del usuario
Guía técnica
API
CGU y datos
  • English
  • Français
  • Español
Guía del usuario
Guía técnica
API
CGU y datos
  • English
  • Français
  • Español
  • API

    • Cómo utilizar la API de BCdiploma
    • Automatizar el proceso de emisión
    • Eliminaciones y desactivaciones
    • Actualización
    • Gestión de plantillas
    • Gestión de rutas de aprendizaje
    • Descarga
    • Exportación de datos
    • Otras API
    • Gestión de errores

Eliminaciones y desactivaciones

Borrado del historial de datos (5) (opcional)

El borrado de los datos de historial permite suprimir los datos que se utilizaron para generar los certificados. Los certificados cuyos datos de historial se hayan borrado seguirán siendo accesibles. No debe confundirse con la eliminación de los propios certificados, documentada más adelante.

Aviso

Atención: el borrado de los datos de historial es irreversible.

Se accede al servicio “Delete” mediante una llamada DELETE al endpoint [API-URL]/admin/campaign?campaignId=XXX, donde XXX es el identificador de la campaña proporcionado en la respuesta del servicio web “Push”.

La respuesta tendrá el estado 204 si todo ha funcionado correctamente.

Eliminación de los certificados

Puede eliminar uno o varios certificados mediante la API.

Aviso

Atención: la eliminación de un certificado es irreversible; los certificados eliminados de este modo quedarán inaccesibles para siempre.

Se accede al servicio web de eliminación de certificados mediante una llamada DELETE al endpoint [API-URL]/admin/keys.

Encabezado HTTP obligatorio: Content-Type: application/json

Ejemplo:

[
"12DC1EBEFDC201FF016C34680C411E85C3EBEB190F1C175327426A4F799A5834cUxBYXA3Q1pzcmh4OUJRV2Z3YVRhbjRCeG00SU9DNnFjYmMvbFk4MUFMeW5qZFlK",
"EE064BB1D32EA96869818860B42C5499B9562B9A35D0C99E9F58E6578D87E5B1WWg2YzJEVFNobS9BZmIyNGYzWkU1aVF5V3lEUEtOS0J3UDlMODd5bFlXektlNnNh"
]

La respuesta tendrá el estado 200 si todo ha funcionado correctamente.

Desactivación/reactivación de certificados

Puede desactivar temporalmente uno o varios certificados mediante la API y reactivarlos posteriormente.

Se accede al servicio web de desactivación/reactivación de certificados mediante una llamada PUT al endpoint [API-URL]/admin/keys.

Encabezado HTTP obligatorio: Content-Type: application/json

El cuerpo de la solicitud es una cadena de caracteres JSON que contiene los siguientes campos:

  • ids: un array de las claves de los certificados que deben desactivarse/reactivarse
  • campaignId: el identificador de la campaña de la que se desea desactivar/reactivar todos los certificados.

Uno de los 2 parámetros anteriores es obligatorio.

  • enable: false para desactivar, true para reactivar, obligatorio.

Ejemplo para suspender 2 certificados:

{
  "ids": [
    "12DC1EBEFDC201FF016C34680C411E85C3EBEB190F1C175327426A4F799A5834cUxBYXA3Q1pzcmh4OUJRV2Z3YVRhbjRCeG00SU9DNnFjYmMvbFk4MUFMeW5qZFlK",
    "EE064BB1D32EA96869818860B42C5499B9562B9A35D0C99E9F58E6578D87E5B1WWg2YzJEVFNobS9BZmIyNGYzWkU1aVF5V3lEUEtOS0J3UDlMODd5bFlXektlNnNh"
  ],
  "enable": false
}

y para reactivarlos:

{
  "ids": [
    "12DC1EBEFDC201FF016C34680C411E85C3EBEB190F1C175327426A4F799A5834cUxBYXA3Q1pzcmh4OUJRV2Z3YVRhbjRCeG00SU9DNnFjYmMvbFk4MUFMeW5qZFlK",
    "EE064BB1D32EA96869818860B42C5499B9562B9A35D0C99E9F58E6578D87E5B1WWg2YzJEVFNobS9BZmIyNGYzWkU1aVF5V3lEUEtOS0J3UDlMODd5bFlXektlNnNh"
  ],
  "enable": true
}

La respuesta tendrá el estado 200 si todo ha funcionado correctamente.

Prev
Automatizar el proceso de emisión
Next
Actualización