openapi: 3.0.3 info: title: 'BrSafe RESTful Doc' description: 'Documentação do Serviço RESTful do BrSafe' version: 1.0.0 servers: - url: 'https://service.brsafe.com.br' paths: /ws-rest/v1/indexadores/gerar: post: summary: 'List the indexes' description: 'Authenticate user and retrieve list of indexes' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string - in: header name: user description: '' example: fr12345 schema: type: string - in: header name: password description: '' example: '123456' schema: type: string responses: { } tags: - Index requestBody: required: false content: application/json: schema: type: object properties: tipoDocumento: type: string description: 'Document type' example: explicabo uf: type: string description: 'State - Max 2 digits' example: DF codUsuario: type: string description: 'User Code' example: earum codReanalise: type: string description: 'Reanalysis code' example: sint /ws-rest/v1/protocolo/consultar: post: summary: 'Query protocol data' description: 'Query protocol data by code' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string - in: header name: user description: '' example: fr12345 schema: type: string - in: header name: password description: '' example: '123456' schema: type: string responses: { } tags: - Queries requestBody: required: false content: application/json: schema: type: object properties: cod_protocolo: type: string description: Protocol example: pariatur /ws-rest/v1/analise/status: post: summary: 'Check the status of an analysis' description: '' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string - in: header name: user description: '' example: fr12345 schema: type: string - in: header name: password description: '' example: '123456' schema: type: string responses: { } tags: - Queries requestBody: required: true content: application/json: schema: type: object properties: cod_usuario: type: string description: 'User of the attendant who performed the scan' example: amet cod_pdv: type: string description: 'Code of the store in which the scan user is associated' example: nulla num_cpfcnpj: type: integer description: 'Customer''s CPF/CNPJ' example: 13 required: - cod_usuario - cod_pdv - num_cpfcnpj /ws-rest/v1/analise/protocolo: post: summary: 'List user records' description: 'List record of a given user according to the contract number, protocol or CPF' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string - in: header name: user description: '' example: fr12345 schema: type: string - in: header name: password description: '' example: '123456' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: num_cpf: '12345678909' protocolo: '12345' contrato: '12345' status_analise: Concluído nom_resultado: 'SEM RISCO APARENTE' data_criacao: 23/11/2020 data_conclusao: 23/11/2020 properties: num_cpf: type: string example: '12345678909' protocolo: type: string example: '12345' contrato: type: string example: '12345' status_analise: type: string example: Concluído nom_resultado: type: string example: 'SEM RISCO APARENTE' data_criacao: type: string example: 23/11/2020 data_conclusao: type: string example: 23/11/2020 tags: - Queries requestBody: required: true content: application/json: schema: type: object properties: cpf: type: integer description: 'User''s CPF' example: 5 protocolo: type: integer description: 'User''s protocol' example: 7 contrato: type: integer description: 'Contract number' example: 9 max_time: type: integer description: 'Maximum search time' example: 13 campos: type: object description: 'Fields list' example: [] properties: cod_loja: type: required description: 'Store code' example: perferendis cod_vendedor: type: integer description: 'Attendant code' example: 11 cod_udid: type: integer description: '' example: 19 cod_agencia: type: integer description: '' example: 11 cod_conta: type: integer description: '' example: 16 cod_dac: type: integer description: '' example: 3 nom_segmento: type: string description: '' example: vel nom_situacao: type: string description: '' example: porro des_produto: type: string description: '' example: quia des_titularidade: type: string description: '' example: amet num_cpfcnpj_empresa: type: integer description: '' example: 13 nom_nome: type: string description: Name example: id des_justificativa: type: string description: '' example: in dat_contrato: type: string description: 'Contract date' example: totam dat_nascimento: type: string description: 'Birth date' example: commodi cod_id_contrato: type: integer description: 'Contract id' example: 17 required: - cpf - protocolo - contrato - max_time - campos /ws-rest/v1/perguntas/gerar: post: summary: 'Query questions' description: 'Method to retrieve questions' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string - in: header name: user description: '' example: fr12345 schema: type: string - in: header name: password description: '' example: '123456' schema: type: string responses: 400: description: '' content: application/json: schema: type: object example: error: name: ParametroInvalido code: 503 status_code: 400 message: 'Parâmetros inválidos.' detail: [] properties: error: type: object example: name: ParametroInvalido code: 503 status_code: 400 message: 'Parâmetros inválidos.' detail: [] tags: - Questions requestBody: required: false content: application/json: schema: type: object properties: token: type: string description: 'Encryption key' example: aut indexadores: type: object description: 'List of index values' example: [] properties: id_indexador: type: integer description: 'Index ID' example: 19 des_valor: type: integer description: 'Index value' example: 4 /ws-rest/v1/resultado/gerar: post: summary: 'Generate result' description: 'Method to generate result' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string - in: header name: user description: '' example: fr12345 schema: type: string - in: header name: password description: '' example: '123456' schema: type: string responses: 400: description: '' content: application/json: schema: type: object example: error: name: ParametroInvalido code: 503 status_code: 400 message: 'Parâmetros inválidos.' detail: [] properties: error: type: object example: name: ParametroInvalido code: 503 status_code: 400 message: 'Parâmetros inválidos.' detail: [] tags: - Result requestBody: required: false content: application/json: schema: type: object properties: token: type: string description: 'Encryption key' example: voluptas respostas: type: object description: 'Response values list' example: [] properties: id_pergunta: type: integer description: 'Question ID' example: 20 id_resposta: type: integer description: 'Response ID' example: 11 tags: - name: Index description: '' - name: Queries description: '' - name: Questions description: '' - name: Result description: ''