API

Respecto al uso de la API, a continuación se indican las siguientes instrucciones:

La documentación completa de la API está disponible en : https://comunidadfeliz.gitbook.io/residents/

log_in: Para autenticarse se requiere su email y contraseña.
Se debe hacer una llamada POST a la URL https://app.comunidadfeliz.com/graphql con sus credenciales de la siguiente forma, si usan un cliente compatible con GraphQL:

------graphql


#mutation

mutation signInUser(
$email: Email!,
$password: String!,
$fcmRegistrationToken: String
) {
signInUser(
input: {
email: $email
password: $password
fcmRegistrationToken: $fcmRegistrationToken
}
) {
data {
communityId
propertyId
user {
id
email
fcmRegistrationToken
token
}
}
message
success
}
}

#variables

{
"email": "kata.kulppi@comunidadfeliz.com",
"password": "",
"fcmRegistrationToken": ""
}

------
#fcmRegistrationToken es token de firebase cloud messaging utilizado para recibir notificaciones push
#En las consultas siguientes se debe de agregar el communityId en el header
------


Alternativamente, pueden usar una llamada HTTP con contenido JSON con el siguiente formato:
------json

{
"query": "mutation { signInUser( email: { email: \"email@dominio\" password: \"password\" } ) { user{ token } } }"
}

El resultado es un JSON con el formato:
------json

{
"data": {
"signInUser": {
"user": {
"token": "token_secreto"
}
}
}
}

El token debe ir en el header con su key "JWTACCESSTOKEN" para el resto de las
consultas que se hagan.
Un ejemplo de consulta puede ser para obtener una URL con el PDF de la última boleta emitida para cada propiedad asociadas a su usuario:
------graphql


query{
user{
properties{
name
address
latestBill{
price
pdfUrl
billDetails{
price
origin
description
title
}
}
}
}
}


El atributo origin puede tomar los siguientes valores:

  • Saldo a favor por pagos del mes
  • Egreso
  • Deuda de períodos pasados
  • Fondo
  • Finiquito
  • Ingreso extraordinario
  • Cargo adeudado
  • Interés o multa
  • Medidor
  • Saldo a favor de meses pasados
  • Cargo
  • Provisión
  • Liquidación de sueldo

Algunas observaciones:

  • "Provisión", "Finiquito" y "Liquidación de sueldo" están actualmente deprecados y solo deberían estar para comunidades antiguas.
    Los gastos comunes fijos se consideran de origen "Egreso".
  • El origen "Interés o multa" solo incluye intereses o multas generados por el software por no pago de gastos comunes en el período correspondiente
  • Las multas individuales ingresadas por el administrador son de tipo "Cargo" o "Cargo adeudado".