Cómo obtener una muestra - web_services - 23.1

Guía de servicios web de Spectrum

Product type
Portfolio
Integrate
Product family
Product
Spectrum > Web Services
Version
23.1
Language
Español (México)
Product name
Spectrum Technology Platform
Title
Guía de servicios web de Spectrum
First publish date
2007
ft:lastEdition
2024-02-07
ft:lastPublication
2024-02-07T18:09:34.894393

Para obtener una muestra, envíe una solicitud al servicio web TokenManagerService en el servidor Spectrum Technology Platform. Puede acceder al WSDL de TokenManagerService aquí:

http://server:port/security/TokenManagerService?wsdl

Para obtener una muestra, envíe una solicitud al servicio web security en el servidor Spectrum Technology Platform. Puede acceder al WSDL de security aquí:

http://server:port/security/rest?_wadl

Este servicio web usa la autenticación básica, por lo que debe incluir un nombre de usuario de Spectrum Technology Platform y una contraseña válidos en la solicitud.

El servicio web TokenManagerService puede emitir dos tipos de muestra.El servicio web security puede emitir dos tipos de muestra. Los tipos de muestras son:

  • Muestra de sesión
  • Muestra abierta

Cómo obtener una muestra de sesión

Una muestra de sesión se vincula a una sesión de usuario y solo la puede usar la computadora que solicitó la muestra. Como está vinculada a una sesión, la muestra no se validará si la sesión queda inactiva durante 30 minutos. La muestra de sesión es el tipo de muestra más segura y es el recomendado para autenticar Spectrum Technology Platform.

Para obtener una muestra de sesión, use esta URL:

http://server:port/security/rest/token/access/session/ttlInMinutes

Donde:

servidor
El nombre de host o la dirección IP del servidor Spectrum Technology Platform.
puerto
El puerto HTTP que usa Spectrum Technology Platform. De manera predeterminada es 8080.
ttlInMinutes
La cantidad de minutos para que la muestra expire, también conocido como la vida útil de la muestra. Si no desea que la muestra tenga una fecha de vencimiento, indique el valor 0.

Esta es una respuesta de muestra:

{    "access_token": "eyJlbmMiOiJBMTI4Q0JDLUhTMjU2IiwiYWxnIjoiZGlyIn0..ESnq4JNEBbVMKycd139z0w.NFXAskVY0seX",    "session": "09aa1fbb-71j3-43c7-ab8c-d800214283d4",    "username": "admin" }

TokenManagerService tiene dos operaciones SOAP para obtener una muestra de sesión.

Operación Descripción

getAccessExpiringToken

Utilice esta operación si desea especificar una hora de vencimiento para la muestra. Esta es una solicitud de muestra:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"    xmlns:tok="http://token.security.common.server.platform.spectrum.precisely.com/">    <soapenv:Header/>    <soapenv:Body>       <tok:getAccessExpiringToken>          <tokenLifeInMinutes>60</tokenLifeInMinutes>       </tok:getAccessExpiringToken>    </soapenv:Body> </soapenv:Envelope>

El elemento <tokenLifeInMinutes> especifica la cantidad de minutos para que la muestra expire, también conocido como la vida útil de la muestra. En este ejemplo, la muestra vencerá en 60 minutos.

Esta es una respuesta de muestra:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">    <soap:Body>       <ns2:getAccessExpiringTokenResponse        xmlns:ns2="http://token.security.common.server.platform.spectrum.precisely.com/">          <return>             <session>ebd7904b-07f6-15c9-82e4-71589131eb01</session>             <token>eyJlbmMiOiJBMTI4Q0JDLUhTMjU2IiwiYWxnIjoiZGlyIn0..2pZB3qgpdC96xfOIPg9</token>             <username>simon0897</username>          </return>       </ns2:getAccessExpiringTokenResponse>    </soap:Body> </soap:Envelope>

getAccessSessionToken

Utilice esta operación si desea obtener una muestra que no tenga fecha de vencimiento. Tenga en cuenta que, aunque la muestra no haya vencido, no será válida si la sesión está inactiva durante 30 minutos.

Esta es una solicitud de muestra:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"    xmlns:tok="http://token.security.common.server.platform.spectrum.precisely.com/">    <soapenv:Header/>    <soapenv:Body>       <tok:getAccessSessionToken/>    </soapenv:Body> </soapenv:Envelope>

Esta es una respuesta de muestra:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">    <soap:Body>       <ns2:getAccessSessionTokenResponse       xmlns:ns2="http://token.security.common.server.platform.spectrum.precisely.com/">          <return>             <session>65822c9b-362e-2e0e-a02a-a50a1a761323</session>             <token>eyJlbmMiOiJBMTI4Q0JDLUhTMjU2IiwiYWxnIjoiZGlyIn0..CEE-C1VjKTha</token>             <username>simon0897</username>          </return>       </ns2:getAccessSessionTokenResponse>    </soap:Body> </soap:Envelope>

La respuesta contiene los siguientes elementos:

access_token
muestra
La muestra de seguridad.
sesión
La ID de sesión de la sesión a la que la muestra está vinculada. La muestra solo se aceptará si esta ID de sesión está incluida en la solicitud. Si se ejecuta una aplicación JavaScript, debe incluir un encabezado de solicitud web withCredentials: true para asegurarse de que el identificador de sesión se pase de un sitio a otro en todas las peticiones.
nombre de usuario
El nombre de usuario de Spectrum Technology Platform usado para obtener la muestra. El nombre de usuario se devuelve solo para fines informativos y no es necesario cuando usa la muestra.

Cómo obtener una muestra abierta

Una muestra abierta no está vinculada a ningún usuario o computadora específico. Es el tipo de muestra menos seguro.

Importante: Evite usar muestras abiertas que no vencen. Si se obtiene una muestra abierta por medio un tercero no autorizado, la muestra se puede usar indefinidamente y desde cualquier equipo para acceder a su servidor Spectrum Technology Platform.

Para obtener una muestra abierta, use esta URL:

http://server:port/security/rest/token/access/ttlInMinutes

Donde:

servidor
El nombre de host o la dirección IP del servidor Spectrum Technology Platform.
puerto
El puerto HTTP que usa Spectrum Technology Platform. De manera predeterminada es 8080.
ttlInMinutes
La cantidad de minutos para que la muestra expire, también conocido como la vida útil de la muestra. Si no desea que la muestra tenga una fecha de vencimiento, indique el valor 0.

Esta es una respuesta de muestra:

{    "access_token": "eyJlbmMiOiJBMTI4Q0JDLUhTMjU2IiwiYWxnIjoiZGlyIn0..fI",    "username": "admin" }

TokenManagerService tiene una operación SOAP para obtener una muestra abierta.

Operación Descripción

getAccessToken

Utilice esta operación para obtener una muestra abierta. Esta es una solicitud de muestra:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"    xmlns:tok="http://token.security.common.server.platform.spectrum.precisely.com/">    <soapenv:Header/>    <soapenv:Body>       <tok:getAccessToken/>    </soapenv:Body> </soapenv:Envelope>

Esta es una respuesta de muestra:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">    <soap:Body>       <ns2:getAccessTokenResponse       xmlns:ns2="http://token.security.common.server.platform.spectrum.precisely.com/">          <return>             <token>eyJlbmMiOiJBMTI4Q0JDLUhTMjU2IiwiYWxnIjoiZGlyIn0..f4JwHB4qPs0l</token>             <username>paul1234</username>          </return>       </ns2:getAccessTokenResponse>    </soap:Body> </soap:Envelope>

La respuesta contiene los siguientes elementos:

access_token
muestra
La muestra de seguridad.
nombre de usuario
El nombre de usuario de Spectrum Technology Platform usado para obtener la muestra. El nombre de usuario se devuelve solo para fines informativos y no es necesario cuando usa la muestra.