Otras API

API de “directorio”

Tiene a su disposición una API que le permite crear una página de directorio basada en el historial de sus campañas de publicación.

Consejos

Los certificados de las campañas cuyos datos de historial se hayan borrado dejarán de ser accesibles a través de esta API.

Con esta API, puede poner a disposición de los internautas una página que les permita buscar un certificado a partir de determinados atributos de dicho certificado. Por ejemplo, una institución de educación superior podrá ofrecer una página de directorio en la que los reclutadores introduzcan “apellido”, “nombre” y “fecha de nacimiento” de un titulado para encontrar su diploma BCdiploma, si existe.

Advertencia

Esta API utiliza los datos de historial empleados para la emisión de los certificados: requiere una autenticación mediante una clave de API de solo lectura. Al poner en línea su página de historial, asegúrese de que la clave de API utilizada no sea visible en el lado del cliente para evitar cualquier uso malintencionado de las API y de los datos.

Se accede a esta API de directorio mediante una llamada GET a la función admin/data, con los siguientes parámetros:

  • campaignId: id de la campaña por la que filtrar los datos
  • templateId: id de la plantilla por la que filtrar los datos
  • ids: EvidenzId(s) del/de los certificados por los que filtrar los datos, pasados en forma de array, separados por "," (p. ej.: [123456, 789456, 456798])
  • language: código ISO del idioma por el que deben filtrarse los datos
  • filter: filtro por la presencia de una cadena de caracteres en el conjunto de los datos
  • cualquier campo del modelo de datos de la plantilla (p. ej.: firstName), con la cadena por la que filtrar los datos como valor (p. ej.: firstName=Annie)
  • status: filtro por estado (1 = Validado, 3 = Eliminado, 6 = Vencido, 9 = Desactivado, 11 = En curso de publicación). Si se desean varios estados, basta con concatenarlos en un array, por ejemplo status=[1,3,6].
  • mailSent: Filtro según si el correo electrónico se ha enviado o no (0 - No enviado, 1 - Enviado, 2 - Rebotado/Bounced, 3 - Abierto (si el seguimiento está activado)).
  • limit: número máximo de registros que se devolverán
  • offset: offset
  • counter: número máximo de registros que se devolverán (sin limit ni offset)
  • regex: si es false, las expresiones regulares se desactivan para las consultas sobre los placeholders (valor predeterminado: true)
  • startdate: solo devuelve los certificados cuya fecha de generación es posterior o igual a startdate, formato ISO YYYY-MM-DD
  • enddate: solo devuelve los certificados cuya fecha de generación es anterior o igual a enddate, formato ISO YYYY-MM-DD

Consejos

  • Por motivos de rendimiento, debe especificar al menos uno de los siguientes datos para utilizar esta API: un identificador de campaña, un identificador de plantilla, una dirección de correo electrónico, una lista de identificadores de certificados o una clave de certificado. Por ello, no puede realizar, en una sola llamada a la API, una búsqueda en la totalidad de sus certificados.

  • La búsqueda distingue entre mayúsculas y minúsculas, es decir, solo obtendrá resultados si la cadena de caracteres buscada es estrictamente idéntica en los datos (y respeta, por tanto, las minúsculas/mayúsculas).

    :::

API de solicitud de autenticación

Consejos

Esta API no requiere token de autenticación

Tiene a su disposición una API que le permite crear una página de autenticación personalizada, en sustitución de la página de autenticación estándar de BCdiploma. Cuando se invoca, este método de API envía un correo electrónico de inicio de sesión a la dirección especificada, siempre que esta esté autorizada.

Se accede al servicio “login” mediante una llamada POST al endpoint [API-URL]/admin/login?email=su_correo&issuer_id=XXX, donde su_correo es la dirección a la que se enviará el correo electrónico de inicio de sesión y XXX es su identificador de emisor.

Su identificador de emisor puede obtenerse en el backoffice haciendo clic en la imagen de una plantilla de certificado. El identificador se encuentra antes del & al final de la URL. Ejemplo: para la plantilla https://certificate-staging.bcdiploma.com/template/2&0x13, se trata de 2.

En caso de éxito, la API devolverá el código 200; en caso contrario, un error 404.

API de recuperación de la lista de plantillas de correo electrónico de un emisor

Esta API permite recuperar la lista de las plantillas de correo electrónico disponibles para cada plantilla de certificado de un emisor. Se accede a ella mediante una llamada GET al endpoint [API-URL]/mailing. Este endpoint devuelve todas las asociaciones disponibles, es decir, una entrada por cada asociación plantilla de correo electrónico / plantilla de certificado. Si una plantilla de certificado está asociada a 2 plantillas de correo electrónico, habrá por tanto 2 entradas.