Skip to content

Dionysus API`s

Alini Ribeiro edited this page May 1, 2019 · 9 revisions

Autenticação

A API de autênticação é um pré requisito para a chamada das demais API`s do sistema, conforme descrito no arquivo README do projeto.

URI:/api/auth
OUTPUT:
{
    "token": "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJhZG1pbkBkaW9ueXN1cy5jb20iLCJyb2xlIjoiUk9MRV9BRE1JTiIsImNyZWF0ZWQiOjE1NTY3NDc4NDY2MTEsImV4cCI6MTU1NzM1MjY0Nn0.jx6iRuhJrS2bcM5KThX-cHYo3ehMVEvkHc8EyAjOHf2u_-pC6iv9PpNcKt3A2en8ffMAoeNIyYS6EwKID2HZBw",
    "user": {
        "id": "a52a2f04-aee1-11e8-98d0-529269fb1459",
        "email": "admin@dionysus.com",
        "password": null,
        "profile": "ROLE_ADMIN",
        "name": "Admin",
        "activatedDate": "2019-05-01"
    }
}

API's de Negócio

API que busca todas as dívidas de um CPF:

URI:/dionysus/getDebts/{cpf}/{pagina}/{tamanho da pagina}
OUTPUT (quando não encontra o dado):

{
    "data": {
        "debts": [],
        "registerFound": 0
    },
    "errors": []
}

OUTPUT (quando o dado é encontrado):
{
    "data": {
        "debts": [
            {
                "originDate": "2017-04-29",
                "lastUpdate": "2018-06-29",
                "description": "Pink dye hair",
                "status": "OPPEN",
                "value": 12552.22,
                "locale": "en_US"
            }
        ],
        "registerFound": 25
    },
    "errors": []
}

API que traz as informações da última busca por um CPF:

URI:/dionysus/getLastSearch/{cpf}
OUTPUT:
{
    "data": {
        "date": "2003-10-13",
        "establishment": {
            "city": "São Paulo",
            "name": "Loja das purpurinas"
        }
    },
    "errors": []
}

API que retorna uma lista com as movimentações financeiras de um CPF:

URI:/dionysus/getFinancialMovement/{cpf}
OUTPUT:
{
    "data": [
        {
            "description": "Alterou valores de purpurina do banco C para o banco D",
            "date": "2000-03-21",
            "value": 41.25,
            "locale": "en_US"
        },
        {
            "description": "Alterou valores de purpurina do banco V para o banco Z",
            "date": "2005-10-19",
            "value": 251.25,
            "locale": "en_US"
        },
        {
            "description": "Alterou valores de purpurina do banco D para o banco A",
            "date": "2006-11-07",
            "value": 25441.25,
            "locale": "en_US"
        }
    ],
    "errors": []
}

API que traz os dados da última compra do cartão de crédito de um CPF:

URI:/dionysus/getLastCredictCardPurchase/{cpf}
OUTPUT:
{
    "data": {
        "establishment": {
            "city": "São Paulo",
            "name": "Loja das purpurinas"
        },
        "date": "2002-04-04",
        "value": 25441.25,
        "locale": "en_US"
    },
    "errors": []
}

API que retorna os rendimentos de um CPF:

URI:/dionysus/getCPFIncome/cpf}/{pagina}/{tamanho da pagina}
OUTPUT (Quando a pessoa não tem nenhum rendimento no sistema):
{
    "data": {
        "personName": "Pink Unicorn with id:22528136102",
        "incomes": [],
        "registerFound": 0
    },
    "errors": []
}

OUTPUT (Quando a pessoa tem rendimento no sistema):
{
    "data": {
        "personName": "Pink Unicorn with id:22528136102",
        "incomes": [
            {
                "type": "REGULAR_WORK",
                "value": 8325.21,
                "frequency": "MOUNTHLY",
                "locale": "en_US"
            }
        ],
        "registerFound": 0
    },
    "errors": []
}

API que retorna os bens de um CPF:

URI:/dionysus/getCPFAssets/cpf}/{pagina}/{tamanho da pagina}
OUTPUT (Quando a pessoa não tem nenhum bem no sistema):
{
    "data": {
        "personName": "Pink Unicorn with id:22528136102",
        "incomes": [],
        "registerFound": 0
    },
    "errors": []
}

OUTPUT (Quando a pessoa tem rendimento no sistema):
{
    "data": {
        "personName": "Pink Unicorn with id:22528136102",
        "assets": [
            {
                "type": "APPARTMENT_IMMOVABLE_PROPERTY",
                "value": 8325.21,
                "locale": "en_US"
            }
        ],
        "registerFound": 2
    },
    "errors": []
}
PS: Quando a pessoa não é encontrada na base de dados, é realizada uma solicitação para o Serviço B, solicitando os dados do CPF.

API retorna os pontos que um CPF possui

URI:/dionysus/CPFPoints/{cpf}
OUTPUT:
{
    "data": {
        "average": 500,
        "age": 69,
        "points": 625
    },
    "errors": []
}

API para Auditoria

API retorna todas as buscas feitas no Dionysus por um CPF (Apenas para Administradores do sistema)

URI:/dionysus/searchHistory/{cpf}
OUTPUT:
{
    "data": [
        {
            "username": "admin@dionysus.com",
            "cpf": "192284262787",
            "searchDate": "2019-05-01"
        }
    ],
    "errors": []
}
Clone this wiki locally