Integração de credenciais de acesso utilizando a API

Documentação de como realizar a integração das credenciais de acesso, utilizando a API do Ronda senior X.

Pré-requisitos gerais

• Estar autenticado no Ronda senior X;
• Possuir uma pessoa cadastrada no Ronda senior X;
• Passar o token no Header.

Consultar uma lista de credenciais

• Chame o serviço GET /credential/provisory/pagedsearchbasic para consultar a lista de credenciais;
• No postman, a página, o total de páginas, o term e o card devem ser passados por parametro na URL (query): https://sam-api.senior.com.br/api/v1/credential/provisory/pagedsearchbasic?page=1&pageSize=10&term&card

Cadastrar uma credencial

Para salvar a credencial:

• Chame o serviço POST /credential/provisory/card;
• Passe o JSON no Body;
• Monte o JSON com os dados da lista da credencial, data de validade, id da pessoa, situação da credencial (0 = inativo, 1 = ativo), tecnologia e numero do crachá, id papel e id grupo.

Exemplo do 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
}

Atualizar ou finalizar uma credencial

• Chame o serviço PUT /credential/provisory/card;
• Passe no body o JSON modificado.

Exemplo do Json

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

Se o retorno do serviço tiver êxito (HTTP 200), não haverá JSON de retorno.

Informações dos serviços

GET /credential/provisory/pagedsearchbasic

Implementation Notes

Return all basic information from card credential from person

Response Class (Status 200)

Return all credentials from person

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

Parameters

Parameter	Description	Parameter Type	Data Type
token	Authentication token	header	string
page	Page number	query	integer
pageSize	Size of page	query	integer
term	Term of person name or document	query	string
card	Card number	query	long

Response Messages

HTTP Status Code	Reason	Response Model
401	Token is invalid or expired
404	Person not found
500	Server error	{   "code": 0,   "message": "string" }

POST /credential/provisory/card

Implementation Notes

Create a new provisory credential of card type, Id field will be ignored

Response Class (Status 200)

Provisory credential of card type

{
  "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
}

Parameters

Parameter	Description	Parameter Type	Data Type
token	Authentication token	header	string
Provisory Card Credential	Provisory Card Credential	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 }

Response Messages

HTTP Status Code	Reason	Response Model
401	Token is invalid or expired
403	No permission to insert holder credential of card type
500	Server error	{   "code": 0,   "message": "string",   "params":   [     "string"   ] }

PUT /credential/provisory/card

Implementation Notes

Update a provisory credential of card type

Parameters

Parameter	Description	Parameter Type	Data Type
token	Authentication token	header	string
Basic Credential	Basic Credential	body	{   "id": 0,    "expirationDate": "string" }

Response Messages

HTTP Status Code	Reason	Response Model
200	Provisory credential of card type updated
401	Token is invalid or expired
403	No permission to holder credential of card type update
404	Provisory credential of card type not found
500	Server error	{   "code": 0,   "message": "string" }