API - Consultar proveedores de servicio (SP) disponibles


Este servicio web ofrece un mecanismo para consultar qué proveedores de servicio están disponibles para un proveedor de identidad en concreto. Está especificado de la siguiente forma:

URL de acceso http://www.rediris.es/sir/api/sps_available.php
Tipo de servicio web REST
Respuesta Mensaje XML

Los parámetros de entrada que acepta son:

Parámetro Obligatorio Descripción
ididp X Id del proveedor de identidad en SIR. Este Id es el usado por el conector o el AuthServer de la institución.
lang   Idioma en que se solicita la respuesta. Disponibles es (siendo éste el valor por defecto) y en.
idsp   Se indica el Id del proveedor de servicio que se quiere buscar.
prot   Se indica el protocolo de identidad digital por el que se quiere filtrar. Disponibles papi, shib13, saml2 y edugain.
category   Se indica la categoría en la que ha sido catalogado cada proveedor de servicio por el que se quiere filtrar. Disponibles 0 (colaboración), 1 (descarga de software), 2 (eduGAIN), 3 (herramientas de RedIRIS) y 4 (recursos de biblioteca).

Un mensaje de respuesta de ejemplo es el siguiente:

<Response>
  <ServiceProvider id="metapress" protocol="saml2" category="4">
    <Name>Metapress</Name>
    <Description>
      MetaPress is a division of EBSCO Industries, Inc., a diversified company founded in 1944 and parent company of the world’s largest subscription agency.
    </Description>
    <URL>http://www.metapress.com/</URL>
    <TechnicalInfo>http://www.rediris.es/sir/sp/metapress.html</TechnicalInfo>
    <Wayfless>
      http://sir.rediris.es/idpfirst/?idpid=us&spid=metapress
    </Wayfless>
    <VideoTutorial>http://blip.tv/file/2131572</VideoTutorial>
  </ServiceProvider>
  <ServiceProvider id="metapress" protocol="saml2" category="4">
    .
    .
    .
  </ServiceProvider>
</Response>

Donde,

  • <Response>: es el elemento XML raíz de toda la respuesta.
  • <ServiceProvider>: es el elemento que describe un proveedor de servicio. Puede aparecer de 0 a N veces.
    • Atributo 'id': indica el Id del proveedor de servicio.
    • Atributo 'protocol': indica el protocolo utilizado para conectarse a dicho proveedor de servicio.
    • Atributo 'category': indica la categoría en la que ha sido clasificado el recurso.
  • <Name>: indica el nombre del proveedor de servicio.
  • <Descripción>: descripción del recurso.
  • <URL>: es la URL de entrada al proveedor de servicio.
  • <TechnicalInfo>: es la URL donde se pueden consultar los detalles técnicos en la integración del recurso en SIR.
  • <Wayfless>: es la URL a través de la cual se puede acceder al recurso sin que el usuario tenga que indicar de qué institución procede. Este elemento no aparecerá si no hay una solución técnica para ofrecer dicha URL.
  • <VideoTutorial>: es la URL de un video que explica al usuario como conectarse al recurso a través de SIR. Este elemento no aparecerá si no hay dicho video para el recurso.