Secure Code Warrior proporciona un conjunto de API para permitir el acceso a los datos de su empresa a través de una aplicación cliente, normalmente una herramienta o plataforma de Business Intelligence.
Nuestra nueva API de informes funciona con GraphQL, que utiliza un formato diferente para consultar datos que los puntos finales de la API REST a los que podría estar acostumbrado.
Nota: No todos los datos y funcionalidades de la API REST existente se replicarán en la nueva API. ¡Si no está seguro de cuál es la mejor consulta o punto final para los datos que está buscando, por favor póngase en contacto con nuestro equipo de soporte!
Generar clave API
Las mismas claves de API (claves de API de informes de sólo lectura o claves de API de gestión de lectura y escritura) que ha configurado para la API REST de SCW también funcionan con la API de informes. La única diferencia es que el encabezado debe tener el siguiente formato
{
"Autorización": "Bearer <> "
}<></></>
Para obtener más información sobre cómo crear y revocar claves API en SCW, consulte Cómo habilitar el acceso a la API.
Documentación de Reporting API
El explorador de la API de generación de informes y la documentación detallada están disponibles a través de los siguientes enlaces:
Explore la API de generación de informes de Secure Code Warrior
Siga los siguientes pasos para empezar
Paso 1
Navegue hasta el Explorador de consultas utilizando los enlaces anteriores
Paso 2
Añada su clave API en la sección "Cabeceras
Paso 3.
Siga la documentación del esquema haciendo clic en el icono 📔 de la parte superior izquierda.
Paso 4
Pruebe las consultas GraphQL escribiéndolas en la ventana central. Dos cosas importantes para recordar:
- Envuelva la consulta entre llaves {}
- Especifique los campos que desea que devuelva la API.
Si eres nuevo en GraphQL, este artículo proporciona una guía para principiantes para escribir tus primeras consultas GraphQL.
Paso 5
Ejecute la consulta. Verá el resultado a la derecha.
Paso 6
Una vez que haya encontrado los datos que busca con su consulta GraphQL, puede enviarlos en el cuerpo de una consulta POST al punto final de la API GraphQL correspondiente que se indica a continuación.
Punto final de la API GraphQL
POST https://api.us.securecodewarrior.com/graphql
POST https://api.eu.securecodewarrior.com/graphql
Nota: Reporting API utiliza un estilo de paginación proporcionado por Relay (https://relay.dev/graphql/connections.htm). Cada consulta devolverá un objeto con 'edges' y 'pageInfo'. Los datos consultados se anidarán dentro del objeto 'edges' como un array de 'nodes' que contienen sus datos. El objeto 'pageInfo' contendrá todo lo necesario para saber si hay una siguiente página de datos que obtener, y el cursor a utilizar para obtenerla.
Algunas aplicaciones cliente GraphQL que pueden ayudarte a realizar consultas:
Enlaces útiles:
Comentarios
0 comentarios
Inicie sesión para dejar un comentario.