Integración de credenciales de acceso utilizando la API

Documentación sobre cómo integrar credenciales de acceso, utilizando la API Ronda senior X.

Prerrequisitos generales

• Estar autenticado en Ronda X senior;
• Tener una persona registrada en Ronda senior X;
• Pase el token en el Header.

Consultar una lista de credenciales

• llame al servicioOBTENER /credencial/provisorio/pagedsearchbasic consultar la lista de credenciales;
• En el postman, la página, el total de páginas, el term y el card deben ser pasados por parámetro en la URL (query): https://sam-api.senior.com.br/api/v1/credential/provisory/pagedsearchbasic?page=1&pageSize=10&term&card

Registrar una credencial

Para guardar la credencial:

• llame al servicioPOST /credencial/provisional/tarjeta;
• Pase el JSON en el Cuerpo;
• Reúna el JSON con los datos de la lista de credenciales, la fecha de vencimiento, la identificación de la persona, el estado de la credencial (0 = inactiva, 1 = activa), la tecnología y el número de placa, la identificación de la función y la identificación del grupo.

Ejemplo del Json

{
"id": 0,
"expirationDate": "string",
"person":
{
"id": 0,
"name": "string"
},
"situation": 0,
"cardCredentialList":
[
{
"cardTechnology": 0,
"cardNumber": 0
}
],
"role":
{
"id": 0,
"name": "string"
},
"group":
{
"id": 0,
"name": "string"
},
"personVisited":
{
"id": 0,
"name": "string"
},
"scheduledCredentialID": 0
}

Actualizar o finalizar una credencial

• llame al servicioPUT /credencial/provisional/tarjeta;
• Pase el JSON modificado en el cuerpo.

Ejemplo del Json

{
"id": 47,
"expirationDate": "2017-03-28T10:00:00-03:00"
}

Si el servicio regresa exitosamente (HTTP 200), no se devolverá ningún JSON.

Informaciones de los servicios

GET /credential/provisory/pagedsearchbasic

Notas de Implementación

Devuelva todas las informaciones básicas de la credenciales de acceso de la persona

Response Class (Status 200)

Devolver todas las credenciales de la persona

[
{
"idCredential": 0,
"person":
{
"id": 0,
"name": "string"
},
"cardCredential":
{
"cardTechnology": 0,
"cardNumber": 0
},
"expirationDate": "string"
}
]

Parámetros

Parámetros	Description	Tipo Parámetro	Tipo Fecha
token	Autenticación token	header	string
page	Page number	query	integer
pageSize	Size of page	query	integer
term	Termo del nombre de persona o del documento	query	string
card	Numero Tarjeta	query	long

Mensajes de Respuesta

HTTP Código Estado	Razón	Modelo de Respuesta
401	Token es inválido o expirado
404	Persona no encontrada
500	Error de Servidor	{ "code": 0, "message": "string" }

POST /credential/provisory/card

Notas de Implementación

Crear una nueva credencial provisional del tipo de tarjeta, campo Id será ignorado

Respuesta Clase (Status 200)

Credencial provisional del tipo de tarjeta

{
"id": 0,
"expirationDate": "string",
"person":
{
"id": 0,
"name": "string"
},
"situation": 0,
"cardCredentialList":
[
{
"cardTechnology": 0,
"cardNumber": 0
}
],
"role":
{
"id": 0,
"name": "string"
},
"group":
{
"id": 0,
"name": "string"
},
"personVisited":
{
"id": 0,
"name": "string"
},
"scheduledCredentialID": 0
}

Parámetros

Parámetros	Description	Tipo Parámetro	Tipo Fecha
token	Autenticación token	header	string
Credencial de Tarjeta Provisional	Credencial de Tarjeta Provisional	body	{ "id": 0, "expirationDate": "string", "person": { "id": 0, "name": "string" }, "situation": 0, "cardCredentialList": [ { "cardTechnology": 0, "cardNumber": 0 } ], "role": { "id": 0, "name": "string" }, "group": { "id": 0, "name": "string" }, "personVisited": { "id": 0, "name": "string" }, "scheduledCredentialID": 0 }

Mensajes de Respuesta

HTTP Código Estado	Razón	Modelo de Respuesta
401	Token es inválido o expirado
403	Ningún permiso para inserir la credencial del titular del tipo de tarjeta
500	Error de Servidor	{ "code": 0, "message": "string", "params": [ "string" [ }

PUT /credential/provisory/card

Notas de Implementación

Actualizar una credencial provisional del tipo de tarjeta

Parameters

Parámetros	Descripción	Tipo Parámetro	Tipo Fecha
token	Autenticación token	header	string
Credencial Básica	Credencial Básica	body	{ "id": 0, "expirationDate": "string" }

Mensajes de Respuesta

HTTP Código Estado	Razón	Modelo de Respuesta
200	Credencial provisional del tipo de tarjeta actualizada
401	Token es inválido o expirado
403	Ningún permiso para la credencial del titular de la actualización del tipo de tarjeta
404	Credencial provisional del tipo de tarjeta no encontrado
500	Error de Servidor	{ "code": 0, "message": "string" }