API#

La pantalla de API tiene tres pestañas:

  1. Swagger
    En este apartado se abre la documentación interactiva de la API. El usuario puede ver las solicitudes disponibles, sus parámetros, la estructura de la respuesta y utilizar Swagger como referencia para verificar integraciones.
    La documentación también está disponible en: https://orchestrator.sherparpa.ru/api/docs/swagger.
  2. ReDoc
    En este apartado se abre una representación alternativa de la documentación de la API.
    ReDoc es cómodo para leer: facilita la visualización de descripciones de métodos, esquemas de datos y campos obligatorios de las solicitudes.
  3. Key
    En este apartado el usuario gestiona la clave de la API.
    Aquí puede ver la clave actual, copiarla o generar una nueva. Esta clave se utiliza para autorizar sistemas externos al acceder a la API de Sherpa Orchestrator.