Versions Compared

Version Old Version 3 New Version Current
Changes made by

Joao Pedro Goncalves Rodrigues Pinto (Unlicensed)

Joao Pedro Goncalves Rodrigues Pinto (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Distribuição de Obras:

Já existe:

Listar Obras

  • Filtro CNPJ:

    Code Block
    Get: https://bancodeobras-api.dev.cloud.dex.co/constructions?page=1&limit=10&cnpj=79.550.091/0001-99

  • Filtro Nome:

    Code Block
    Get: https://bancodeobras-api.dev.cloud.dex.co/constructions?page=1&limit=10&company=Catuai Construtora e Incorporadora

  • Filtro Cidade:

    Code Block
    Get: https://bancodeobras-api.dev.cloud.dex.co/constructions?page=1&limit=10&city=São Paulo

O endpoint para lista Obras é:

Code Block
Get: https://bancodeobras-api.dev.cloud.dex.co/constructions?page=1&limit=10

Sendo page e limit parametros da paginação.

O objeto de resposta segue com o padrão paginado mostrado no exemplo abaixo:

Code Block
{
    "docs": [
        {
            "amount": {
                "rooms": "60",
                "floors": "12",
                "area": "847",
                "apartments": "0"
            },
            "address": {
                "street": "Rua Vergueiro",
                "number": "2573",
                "district": "Vila Mariana",
                "city": "São Paulo",
                "state": "SP",
                "region": "Sudeste",
                "country": "Brasil",
                "zipCode": "4101200"
            },
            "workPhase": "Execução",
            "status": "Obra em Construção",
            "investment": {
                "total": "0",
                "greatness": "MI"
            },
            "_id": "6345bd2756a6286f55a89f45",
            "name": "Exclusive Offices Vergueiro",
            "code": "120190",
            "type": "Comercial / Institucional",
            "sector": "Edificações",
            "category": "Prédio Comercial",
            "finishPhaseAt": "2022-12-10T00:00:00.000Z",
            "finishingDetail": "Médio",
            "deliveryAt": "2022-12-10T00:00:00.000Z",
            "companies": [
                {
                    "corporateName": "Tiberio Construções e Incorporações S.A",
                    "cnpj": "47140330000146",
                    "state": "SP",
                    "city": "SÃO PAULO",
                    "types": [
                        "Construtor"
                    ],
                    "_id": "6345d0affda8477553e349ec",
                    "contacts": []
                }
            ],
            "internalAreas": [],
            "createdAt": "2022-10-11T18:59:51.219Z",
            "updatedAt": "2022-10-11T18:59:51.219Z",
            "__v": 0
        }
    ],
    "totalDocs": 1,
    "limit": 10,
    "totalPages": 1,
    "page": 1,
    "pagingCounter": 1,
    "hasPrevPage": false,
    "hasNextPage": false,
    "prevPage": null,
    "nextPage": null
}

Os parametros city, company e cnpj estão reservados como mostrado nas urls na lista de filtros acima. Mas pode ser feito qualquer pesquisa dentro do banco passando a chave do parametro e o valor qual seria pesquisado. Ex:

Code Block
Get: https://bancodeobras-api.dev.cloud.dex.co/constructions?page=1&limit=10&sector=Edificações

Update Obras

  • Inserir/Mudar Colaborador (Seller)

  • Inserir/Mudar Coordenador

São inseridos e atualizados pelo menos endpoint:

Code Block
POST: https://bancodeobras-api.dev.cloud.dex.co/constructions/{construction}/collaborator

Sendo Construction o id da construção que irá inserir o colaborador. Ex

Code Block
POST: https://bancodeobras-api.dev.cloud.dex.co/constructions/6345bd2756a6286f55a89f51/collaborator

O JSON é um array com até 6 objetos

  • _id: id do usuário que será inserido na obra

  • brand: marca qual o usuario será relacionado

  • type: tipo do usuário; coordinator (coordenador), seller (vendedor)

Code Block
[
    {
    "_id": "634956505d5f0dc2af2ede4e",
    "brand": "deca",
    "type": "coordinator"
    },{
    "_id": "634956505d5f0dc2af2ede4e",
    "brand": "durafloor",
    "type": "coordinator"
    },{
    "_id": "634956505d5f0dc2af2ede4e",
    "brand": "rc",
    "type": "coordinator"
    },{
    "_id": "63494576c0effd329aea260d",
    "brand": "durafloor",
    "type": "seller"
    },{
    "_id": "63494576c0effd329aea260d",
    "brand": "deca",
    "type": "seller"
    },{
    "_id": "63494576c0effd329aea260d",
    "brand": "rc",
    "type": "seller"
    }
]

Get Me - Menu Mobile

Para receber as informações do usuário e preencher o menu lateral

Code Block
Get: https://bancodeobras-api.dev.cloud.dex.co/user/me

Filtros para Cidades

Faz o distinct de quais estados / cidades existem no banco de obras para filtro

Code Block
Get: https://bancodeobras-api.dev.cloud.dex.co/constructions/filters

...

Documentação para importar no postman:

Segue a documentação do API do novo banco de obras. Para maiores informações de como gerar ou importar essa documentação olhar no tópico: Como importar Documentação do Postman

Gerada no dia 14/10/2022

View file
namepostman.json

Como importar Documentação do Postman:

Existe uma documentação dos endpoints da aplicação. Primeiramente é necessário fazer o clone do projeto e instalação de suas depências.

A doc pode ser gerada pelo comando do bash:

Code Block
npm run generateDoc

Ao rodar esse comando será gerado dois arquivos com o nome de openapi.json e postman.json que serão salvos dentro da pasta app da aplicação como mostrado na figura

...

Para a visualização é necessário baixar e instalar o POSTMAN.

Com o postman instalado é necessário clicar no icone “hamburguer” (icone com 3 linhas paralelas horizontalmente) encontrado no canto superior esquerdo da tela

...

Nesse icone ir na opção file (arquivo) → import (importar) ou usar o comando ctrl+ O. Após feito, navegar até o diretório app do projeto e selecionar o arquivo postman.json.

...

Após importar os endpoints estarão na parte de Collections (coleções) do postman.

...

Telas:

Page Tree
root@self
startDepth1