{"swagger":"2.0","info":{"version":"v1","title":"CFIcatalogo"},"tags":[{"name":"Arquivo"},{"name":"Distribuidor Autorizado"},{"name":"Fabricante"},{"name":"Item Financiavel"},{"name":"Programa"}],"schemes":["https","http"],"paths":{"/arquivo/{id}":{"get":{"tags":["Arquivo"],"summary":"Obter bytes do arquivo com um ID fornecido","description":"","operationId":"getDados","consumes":["application/json; charset=utf-8"],"produces":["application/json; charset=utf-8"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","pattern":"\\d+","format":"int64"}],"responses":{"200":{"description":"Consulta realizada com sucesso"},"403":{"description":"Acesso negado ao arquivo solicitado"},"404":{"description":"Nenhum registro encontrado"},"500":{"description":"Erro inesperado no servidor"}},"x-auth-type":"None","x-throttling-tier":"Unlimited"}},"/distribuidorAutorizado/{cnpj}/endereco":{"get":{"tags":["Distribuidor Autorizado"],"summary":"Endereço do distribuidor autorizado","description":"","operationId":"getEndereco","consumes":["application/json; charset=utf-8"],"produces":["application/json; charset=utf-8"],"parameters":[{"name":"cnpj","in":"path","description":"CNPJ do distribuidor autorizado","required":true,"type":"string","pattern":"[0-9]{1,14}"}],"responses":{"200":{"description":"Consulta realizada com sucesso, mesmo que vazia","schema":{"type":"array","items":{"$ref":"#/definitions/ContatoEndereco"}}},"500":{"description":"Erro inesperado no servidor"}},"x-auth-type":"None","x-throttling-tier":"Unlimited"}},"/distribuidorAutorizado/{cnpj}/fabricantes":{"get":{"tags":["Distribuidor Autorizado"],"summary":"Fabricantes por CNPJ do distribuidor autorizado","description":"","operationId":"getFabricantes","consumes":["application/json; charset=utf-8"],"produces":["application/json; charset=utf-8"],"parameters":[{"name":"cnpj","in":"path","description":"CNPJ do distribuidor autorizado","required":true,"type":"string","pattern":"[0-9]{1,14}"}],"responses":{"200":{"description":"Consulta realizada com sucesso, mesmo que vazia","schema":{"type":"array","items":{"$ref":"#/definitions/Fabricante"}}},"500":{"description":"Erro inesperado no servidor"}},"x-auth-type":"None","x-throttling-tier":"Unlimited"}},"/distribuidorAutorizado/{cnpj}/itensfinanciaveis":{"get":{"tags":["Distribuidor Autorizado"],"summary":"Itens financiáveis por CNPJ do distribuidor autorizado","description":"","operationId":"getItensFinanciaveis","consumes":["application/json; charset=utf-8"],"produces":["application/json; charset=utf-8"],"parameters":[{"name":"cnpj","in":"path","description":"CNPJ do distribuidor autorizado","required":true,"type":"string","pattern":"[0-9]{1,14}"}],"responses":{"200":{"description":"Consulta realizada com sucesso","schema":{"type":"array","items":{"$ref":"#/definitions/ItemFinanciavelAPIDTO"}}},"404":{"description":"Nenhum registro encontrado"},"500":{"description":"Erro inesperado no servidor"}},"x-auth-type":"None","x-throttling-tier":"Unlimited"}},"/fabricante/buscar":{"get":{"tags":["Fabricante"],"summary":"Fabricantes por palavra-chave (limitado a 100 resultados)","description":"","operationId":"getFabricante","consumes":["application/json; charset=utf-8"],"produces":["application/json; charset=utf-8"],"parameters":[{"name":"keyword","in":"query","description":"Filtrar por palavra-chave","required":true,"type":"string"},{"name":"uf","in":"query","description":"Filtrar por uf","required":false,"type":"string"},{"name":"idMunicipio","in":"query","description":"Filtrar por municipio","required":false,"type":"integer","format":"int64"},{"name":"categoria","in":"query","description":"Filtrar por categoria (fabricante, engenharia ou serviço)","required":false,"type":"string"},{"name":"inicio","in":"query","description":"Início","required":false,"type":"integer","default":0,"minimum":0,"format":"int32"},{"name":"quantidade","in":"query","description":"Quantidade","required":false,"type":"integer","default":30,"minimum":1,"format":"int32"}],"responses":{"200":{"description":"Consulta realizada com sucesso e com pelo menos algum resultado","schema":{"type":"array","items":{"$ref":"#/definitions/FabricanteAPIDTO"}}},"400":{"description":"Consulta não realizada devido a palavra chave pequena."},"500":{"description":"Erro inesperado no servidor"}},"x-auth-type":"None","x-throttling-tier":"Unlimited"}},"/fabricante/cnpj/{cnpj}":{"get":{"tags":["Fabricante"],"summary":"Consulta dados de um fabricante utilizando seu CNPJ","description":"","operationId":"getDadosAdicionaisFabricante","consumes":["application/json; charset=utf-8"],"produces":["application/json; charset=utf-8"],"parameters":[{"name":"cnpj","in":"path","description":"CNPJ do fabricante","required":true,"type":"string","pattern":"[0-9]{1,14}"}],"responses":{"200":{"description":"Consulta realizada com sucesso","schema":{"$ref":"#/definitions/DadosAdicionaisFabricanteAPIDTO"}},"404":{"description":"Nenhum registro encontrado"},"500":{"description":"Erro inesperado no servidor"}},"x-auth-type":"None","x-throttling-tier":"Unlimited"}},"/fabricante/{cnpj}/quantidadeProdutosServicos":{"get":{"tags":["Fabricante"],"summary":"Consulta quantidade de itens financiveis e servios do fornecedor utilizando o CNPJ do fabricante.","description":"","operationId":"findQuantidadeProdutoServico","consumes":["application/json; charset=utf-8"],"produces":["application/json; charset=utf-8"],"parameters":[{"name":"cnpj","in":"path","description":"CNPJ do fabricante","required":true,"type":"string","pattern":"[0-9]{1,14}"}],"responses":{"200":{"description":"Consulta realizada com sucesso","schema":{"$ref":"#/definitions/QuantidadeProdutosServicosFabricante"}},"500":{"description":"Erro inesperado no servidor"}},"x-auth-type":"None","x-throttling-tier":"Unlimited"}},"/fabricante/{cnpj}/{data}/distribuidoresAutorizados":{"get":{"tags":["Fabricante"],"summary":"Distribuidores autorizados por CNPJ do fabricante e data","description":"","operationId":"getDistribuidoresAutorizados","consumes":["application/json; charset=utf-8"],"produces":["application/json; charset=utf-8"],"parameters":[{"name":"cnpj","in":"path","description":"CNPJ do fabricante","required":true,"type":"string","pattern":"[0-9]{1,14}"},{"name":"data","in":"path","description":"Data da consulta (AAAAMMDD)","required":true,"type":"string","pattern":"\\d+"}],"responses":{"200":{"description":"Consulta realizada com sucesso, mesmo que vazia","schema":{"type":"array","items":{"$ref":"#/definitions/DistribuidorAutorizado"}}},"500":{"description":"Erro inesperado no servidor"}},"x-auth-type":"None","x-throttling-tier":"Unlimited"}},"/itemfinanciavel/buscar":{"get":{"tags":["Item Financiavel"],"summary":"Consulta de itens do tipo produto utilizando parâmetros (limitado a 30 resultados). A consulta pode ser por nome, modelo, NCM, código CFI e CNPJ do fabricante","description":"","operationId":"findProdutosPorParametros","consumes":["application/json; charset=utf-8"],"produces":["application/json; charset=utf-8"],"parameters":[{"name":"keyword","in":"query","description":"Filtrar por palavra-chave","required":false,"type":"string"},{"name":"categoria","in":"query","description":"Filtrar por categoria (fabricante, engenharia ou serviço)","required":false,"type":"integer","format":"int64"},{"name":"programa","in":"query","description":"Filtrar por prograama","required":false,"type":"integer","format":"int64"},{"name":"inicio","in":"query","description":"Início","required":false,"type":"integer","default":0,"format":"int32"},{"name":"quantidade","in":"query","description":"Quantidade","required":false,"type":"integer","default":30,"format":"int32"}],"responses":{"200":{"description":"Consulta realizada com sucesso","schema":{"$ref":"#/definitions/ResultadoPaginadoItemFinanciavelDTO"}},"404":{"description":"Nenhum registro encontrado"},"500":{"description":"Erro inesperado no servidor"}},"x-auth-type":"None","x-throttling-tier":"Unlimited"}},"/itemfinanciavel/codigo/{codigo}":{"get":{"tags":["Item Financiavel"],"summary":"Consulta item financiável usando o código CFI","description":"","operationId":"getDadosAdicionaisItemFinanciavel","consumes":["application/json; charset=utf-8"],"produces":["application/json; charset=utf-8"],"parameters":[{"name":"codigo","in":"path","description":"Código CFI","required":true,"type":"string","pattern":"[0-9]+"}],"responses":{"200":{"description":"Consulta realizada com sucesso","schema":{"$ref":"#/definitions/DadosAdicionaisItemFinanciavelAPIDTO"}},"404":{"description":"Nenhum registro encontrado"},"500":{"description":"Erro inesperado no servidor"}},"x-auth-type":"None","x-throttling-tier":"Unlimited"}},"/itemfinanciavel/servico/buscar":{"get":{"tags":["Item Financiavel"],"summary":"Consulta de itens do tipo serviço utilizando parâmetros (limitado a 30 resultados). A consulta pode ser por nome, modelo, NBS, código CFI e CNPJ do fabricante","description":"","operationId":"findServicosPorParametros","consumes":["application/json; charset=utf-8"],"produces":["application/json; charset=utf-8"],"parameters":[{"name":"categoria","in":"query","description":"Filtrar por categoria (fabricante, engenharia ou serviço)","required":false,"type":"integer","format":"int64"},{"name":"programa","in":"query","description":"Filtrar por prograama","required":false,"type":"integer","format":"int64"},{"name":"keyword","in":"query","description":"Filtrar por palavra-chave","required":false,"type":"string"},{"name":"inicio","in":"query","description":"Início","required":false,"type":"integer","default":0,"minimum":0,"format":"int32"},{"name":"quantidade","in":"query","description":"Quantidade","required":false,"type":"integer","default":30,"minimum":1,"format":"int32"}],"responses":{"200":{"description":"Consulta realizada com sucesso","schema":{"$ref":"#/definitions/ResultadoPaginado"}},"404":{"description":"Nenhum registro encontrado"},"500":{"description":"Erro inesperado no servidor"}},"x-auth-type":"None","x-throttling-tier":"Unlimited"}},"/itemfinanciavel/{codigo}/foto":{"get":{"tags":["Item Financiavel"],"summary":"Foto de exibição do item","description":"","operationId":"recuperarFoto","consumes":["application/json; charset=utf-8"],"produces":["application/json; charset=utf-8"],"parameters":[{"name":"codigo","in":"path","required":true,"type":"string","pattern":"\\d+"}],"responses":{"200":{"description":"Consulta realizada com sucesso"},"400":{"description":"Erro lendo os dados do arquivo solicitado"},"404":{"description":"Nenhum registro encontrado"},"500":{"description":"Erro inesperado no servidor"}},"x-auth-type":"None","x-throttling-tier":"Unlimited"}},"/programa/listar":{"get":{"tags":["Programa"],"summary":"Programas/Linhas habilitados(as)","description":"","operationId":"carregarProgramas","consumes":["application/json; charset=utf-8"],"produces":["application/json; charset=utf-8"],"responses":{"200":{"description":"Consulta realizada com sucesso","schema":{"$ref":"#/definitions/ProgramaAgrupadoQuantidade"}},"500":{"description":"Erro inesperado no servidor"}},"x-auth-type":"None","x-throttling-tier":"Unlimited"}}},"definitions":{"CaracteristicaTecnicaItemDTO":{"type":"object","properties":{"nomeCaracteristicaTecnica":{"type":"string"},"valor":{"type":"string"},"nomeUnidadeMedida":{"type":"string"}}},"CategoriaItemFinanciavelDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"nome":{"type":"string"},"totalItens":{"type":"integer","format":"int64"},"subcategorias":{"type":"array","items":{"$ref":"#/definitions/CategoriaItemFinanciavelDTO"}}}},"ContatoEndereco":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"logradouro":{"type":"string"},"numeroLogradouro":{"type":"string"},"complementoLogradouro":{"type":"string"},"bairro":{"type":"string"},"cep":{"type":"string"},"municipio":{"type":"string"},"uf":{"type":"string"},"versao":{"type":"integer","format":"int32"}}},"DadosAdicionaisFabricanteAPIDTO":{"type":"object","properties":{"cnpj":{"type":"string"},"raizCnpj":{"type":"string"},"razaoSocial":{"type":"string"},"nomeFantasia":{"type":"string"},"idLogo":{"type":"integer","format":"int64"},"idCatalogoComercial":{"type":"integer","format":"int64"},"telefoneComercial":{"type":"string"},"quemSomos":{"type":"string"},"emailComercial":{"type":"string"},"endereco":{"$ref":"#/definitions/EnderecoLivre"},"videoComercial":{"type":"string"},"linkedIn":{"type":"string"},"youTube":{"type":"string"},"instagram":{"type":"string"},"facebook":{"type":"string"},"whatsApp":{"type":"string"},"site":{"type":"string"},"itensEmDestaque":{"type":"array","items":{"$ref":"#/definitions/ItemFinanciavelAPIDTO"}},"areasAtuacao":{"type":"array","items":{"type":"string"}}}},"DadosAdicionaisItemFinanciavelAPIDTO":{"type":"object","properties":{"codigoFiname":{"type":"string"},"numeroNcm":{"type":"string"},"numeroNbs":{"type":"string"},"nomeItem":{"type":"string"},"modeloItem":{"type":"string"},"distribuidorAutorizado":{"type":"string"},"fabricante":{"type":"string"},"cnpjFabricante":{"type":"string"},"posicaoCadastral":{"type":"string"},"vidaUtil":{"type":"number","format":"double"},"percentualParticipacaoMaxima":{"type":"number","format":"double"},"valorVenda":{"type":"number","format":"double"},"nomeTipoItem":{"type":"string"},"nomeNaturezaItem":{"type":"string"},"ppb":{"type":"string"},"pnp":{"type":"string"},"tecnologiaNacional":{"type":"string"},"possuiImagem":{"type":"boolean","default":false},"segmentosDemanda":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"caracteristicasEspeciais":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"caracteristicasTecnicas":{"type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/CaracteristicaTecnicaItemDTO"}},"descricaoComercial":{"type":"string"},"linkVideoComercial":{"type":"string"},"familias":{"type":"array","items":{"type":"string"}},"documentos":{"type":"array","items":{"type":"string"}},"imagensAdicionais":{"type":"array","items":{"type":"integer","format":"int64"}},"dadosFabricante":{"$ref":"#/definitions/DadosAdicionaisFabricanteAPIDTO"},"tipo":{"type":"string"},"programas":{"type":"array","items":{"$ref":"#/definitions/ProgramaAPIDTO"}},"descricaoNcm":{"type":"string"},"descricaoNbs":{"type":"string"},"textoMotivoPosicaoCadastral":{"type":"string"}}},"DistribuidorAutorizado":{"type":"object","properties":{"versao":{"type":"integer","format":"int32"},"id":{"type":"integer","format":"int64"},"idDistribuidorAutorizado":{"type":"integer","format":"int64"},"cnpj":{"type":"string"},"razaoSocial":{"type":"string"},"inicioVigencia":{"type":"string","format":"date-time"}}},"EnderecoLivre":{"type":"object","properties":{"logradouro":{"type":"string"},"numero":{"type":"string"},"complemento":{"type":"string"},"bairro":{"type":"string"},"municipio":{"type":"string"},"uf":{"type":"string"},"cep":{"type":"string"}}},"Fabricante":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"razaoSocial":{"type":"string"},"nomeFantasia":{"type":"string"},"cnpj":{"type":"string"},"raizCnpj":{"type":"string"},"idMatriz":{"type":"integer","format":"int64"},"telefone":{"type":"string"},"siteInstitucional":{"type":"string"},"idContato":{"type":"integer","format":"int64"},"optanteSimples":{"type":"boolean","default":false},"ativoReceita":{"type":"boolean","default":false},"ultimaAtualizacao":{"type":"string","format":"date-time"},"idUltimaVersao":{"type":"integer","format":"int64"},"versao":{"type":"integer","format":"int32"}}},"FabricanteAPIDTO":{"type":"object","properties":{"cnpj":{"type":"string"},"raizCnpj":{"type":"string"},"razaoSocial":{"type":"string"},"nomeFantasia":{"type":"string"},"idLogo":{"type":"integer","format":"int64"}}},"ItemFinanciavelAPIDTO":{"type":"object","properties":{"codigoFiname":{"type":"string"},"numeroNcm":{"type":"string"},"numeroNbs":{"type":"string"},"nomeItem":{"type":"string"},"modeloItem":{"type":"string"},"distribuidorAutorizado":{"type":"string"},"fabricante":{"type":"string"},"cnpjFabricante":{"type":"string"},"posicaoCadastral":{"type":"string"},"vidaUtil":{"type":"number","format":"double"},"percentualParticipacaoMaxima":{"type":"number","format":"double"},"valorVenda":{"type":"number","format":"double"},"nomeTipoItem":{"type":"string"},"nomeNaturezaItem":{"type":"string"},"ppb":{"type":"string"},"pnp":{"type":"string"},"tecnologiaNacional":{"type":"string"},"possuiImagem":{"type":"boolean","default":false},"segmentosDemanda":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"caracteristicasEspeciais":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"caracteristicasTecnicas":{"type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/CaracteristicaTecnicaItemDTO"}}}},"ProgramaAPIDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"nome":{"type":"string"}}},"ProgramaAgrupadoQuantidade":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"nome":{"type":"string"},"totalItens":{"type":"integer","format":"int64"}}},"QuantidadeProdutosServicosFabricante":{"type":"object","properties":{"qtdProdutos":{"type":"integer","format":"int64"},"qtdServicos":{"type":"integer","format":"int64"}}},"ResultadoPaginado":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entidades":{"type":"array","items":{"type":"object"}},"inicio":{"type":"integer","format":"int32"},"quantidade":{"type":"integer","format":"int32"}}},"ResultadoPaginadoItemFinanciavelDTO":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entidades":{"type":"array","items":{"$ref":"#/definitions/ItemFinanciavelAPIDTO"}},"inicio":{"type":"integer","format":"int32"},"categorias":{"type":"array","items":{"$ref":"#/definitions/CategoriaItemFinanciavelDTO"}},"programas":{"type":"array","items":{"$ref":"#/definitions/ProgramaAgrupadoQuantidade"}},"quantidade":{"type":"integer","format":"int32"}}}},"host":"apis-gateway.bndes.gov.br","basePath":"/catalogoCFI/v1","securityDefinitions":{"default":{"type":"oauth2","authorizationUrl":"https://apis-gateway.bndes.gov.br/authorize","flow":"implicit","scopes":{}}}}