Visión general
Secure Code Warrior Direct Linking API es un servicio RESTful JSON que permite a nuestros socios recuperar material de formación sobre seguridad de aplicaciones. El material disponible incluye enlaces a vídeos explicativos y ejercicios de formación en más de 50 idiomas y marcos de trabajo, todo ello diseñado para ofrecer a los desarrolladores oportunidades de microaprendizaje contextualmente relevantes desde los productos de los socios.
La API está diseñada para ser utilizada por un producto asociado y proporciona acceso a material de formación sobre seguridad de las aplicaciones que puede vincularse o integrarse en el producto. Es compatible con una serie de referencias de vulnerabilidad estándar del sector, como CWE y OWASP, y también permite al producto asociado especificar el idioma y el marco del contenido del ejercicio.
La API de enlace directo debe utilizarse de acuerdo con nuestras [Condiciones del servicio].
Configuración
Para poder invocar la API necesitará un ID de socio, que le proporcionará un miembro de nuestro equipo de asociaciones. Póngase en contacto con nosotros si no lo ha recibido.
También tendrá que asignar sus categorías de vulnerabilidad a las nuestras. El enfoque más sencillo para asignar categorías es utilizar un estándar del sector como las referencias CWE u OWASP; si ya asigna sus categorías de vulnerabilidad a estas, no es necesario crear una asignación personalizada. Las asignaciones válidas pueden obtenerse de la propia API [aquí]. No obstante, si prefiere una asignación personalizada y más precisa, póngase en contacto con nuestro equipo de asociaciones para que le ayuden a empezar.
Por último, tendrá que asignar sus lenguajes y marcos de desarrollo a los nuestros. Las claves válidas para la API de Direct Linking pueden obtenerse en la propia API [aquí]. Una vez que hayas mapeado tus lenguajes y frameworks a las LanguageKeys correspondientes habrás completado la configuración requerida.
Uso
El punto final de la API de Direct Linking se encuentra en:
- https://integration-api.securecodewarrior.com/api/v1/trial
Se puede llamar mediante HTTP GET con los siguientes parámetros:
- Id - Su ID de socio
- MappingList - El mapeo personalizado o esquema de referencia de vulnerabilidad a utilizar
- MappingKey - La clave de mapeo o referencia para recuperar el material de formación.
- LanguageKey - El idioma y el marco para recuperar ejercicios de formación en
Por ejemplo, la siguiente llamada a la API devolverá JSON con material de formación sobre inyección SQL (MappingList CWE y MappingKey 89) en Java utilizando el framework Spring (LanguageKey java:spring):
La API responderá con JSON que contiene las siguientes propiedades que pueden incrustarse en el producto asociado o añadirse como enlace:
- url - Un enlace a ejercicios de formación en la plataforma Secure Code Warrior en el lenguaje y marco especificados, si están disponibles.
- name - El nombre para mostrar de la vulnerabilidad
- descripción - Una descripción de alto nivel de la vulnerabilidad
- videos - Una serie de enlaces a videos explicativos relevantes sobre el tema de la vulnerabilidad
Si la MappingKey no tiene una correspondencia válida con el material de formación, se devolverá un error 404 no encontrado, lo que permitirá al producto asociado gestionar este caso y suprimir la visualización de cualquier material de formación.
Primeros pasos
Para acceder al Direct Linking API Center para ver la documentación de referencia completa y acceder al explorador de API interactivo, haga clic en [aquí].
Biblioteca cliente de navegador
Hay disponible una sencilla biblioteca cliente de navegador para su uso con cualquier interfaz web, y como ejemplo de implementación de cómo llamar a la API de Direct Linking:
La siguiente captura de pantalla muestra un informe de ejemplo de un escáner de seguridad de análisis estático ficticio. Las secciones resaltadas en azul se han rellenado dinámicamente desde la API de enlace directo basada en la referencia CWE para incrustar el vídeo explicativo, la descripción de texto y el botón de formación contextual directamente en el informe generado por el escáner. Vea el informe de ejemplo en vivo [aquí].
Comentarios
0 comentarios
El artículo está cerrado para comentarios.