Documentação
EDI – WebService – Compradores
Projeto: Guia de Integração de Sistemas para compradores (EDI).
Preparador para: OPMEnexo
Preparador por: Saincler Silva
Data Criação: 01 de Junho de 2011
Data última modificação: 17 de Outubro de 2016
Número do Documento: 201610001
Versão: 2.0
ÍNDICE DE VERSÕES
Versão Data Autor Revisor Descrição
1.0 01/06/2011 Daniel Rocha Daniel Rocha Preparo de template e tradução para versão beta.
1.1 04/01/2013 Saincler Silva Inserção de novas operações: listarProdutos, atualizarProdutos, autorizarPedidoProdutos, incluirItensExtras, autorizarFaturamento
1.2 07/01/2013 Saincler Silva Atualização dos layouts das novas operações novas.
1.3 11/01/2013 Saincler Silva Alteração dos layouts para cada operação.
1.4 30/01/2013 Gabriel Lett Documento migrado para o Google Docs, detalhamento do WebSercice WSPedido, dos parametros obrigatórios e possíveis retornos dos métodos autorizarFaturamento, listarCadastroProduto, atualizarCadastroProduto
1.5 23/09/2013 Saincler Silva Inserção da descrição detalhada de cada tag dos layouts das operações: incluirPedido, listarRespostasPedido, incluirItensCarrinho, autorizarPedido.Alteração do índice.
1.6 22/11/2013 Saincler Silva Tópico 4.6: Acrescentado status VENCIDO no método consultarStatusPedido
Tópico 10: Acrescentado novas URLs e WSDLs de homologação e produção para método de CONTRATOS
1.7 25/11/2013 Saincler Silva Tópico 4.17: Acrescentado operação listarResgateFornecedor e layout de retorno.
1.8 10/12/2013 Saincler Silva Acrescentado tópicos 5.1 e 5.2 referente a integração Catálogo.
1.9 05/11/2015 Carina Nagano Foram adicionados e retiradas tags no retorno do método listarProdutosContratosValidar, chamado de Retorno_listarProdutosContratosValidar.Tags:Adicionadas<Valor_Sugerido><Descricao_Produto><Id_Contrato>
<Pais><Descricao_Produto>
Retiradas<Id_Marca><descricao_detalhada<descricao_resumida_material><partnumber><endereco_fabricante><Valor_Contrato><Preco_Referencia> <Preco_Inicial>
Atualização da planilha de forma_pagamento e unidade_medida
2.0 17/10/2016 Saincler Silva Alterado URL de testes de Homolog para Sandbox.
ÍNDICE:1. Objetivo.............................................................................................................................................................. 6
2. Definição............................................................................................................................................................ 7
3. WebService WSPedido...................................................................................................................................... 8
3.1. Layout de envio:.......................................................................................................................................... 8
3.2. Layout de Retorno:...................................................................................................................................... 8
4. Operações.......................................................................................................................................................... 9
4.1. Operação: “incluirPedido” –...................................................................................................................... 9
4.2. Operação: “confirmarPedido”................................................................................................................... 11
4.3. Operação: “alterarPedido”........................................................................................................................11
4.4. Operação: “autorizarPedido”.................................................................................................................... 11
4.5. Operação: “cancelarPedido”.................................................................................................................... 11
4.6. Operação: “consultarStatusPedido”.........................................................................................................12
4.7. Operação: “incluirItensCarrinho”..............................................................................................................12
4.8. Operação: “incluirPedidoReposicao”........................................................................................................13
4.9. Operação: “listarCarrinho”........................................................................................................................13
4.10. Operação: listarRespostasPedido........................................................................................................14
4.11. Operação: listarRespostasPedidoConfirmado.....................................................................................15
4.12. listarCadastroProduto........................................................................................................................... 16
4.12.1. Mensagem de entrada:................................................................................................................. 16
4.12.2. Processamento do envio...............................................................................................................16
4.12.2.1. Validações iniciais....................................................................................................................16
4.12.2.2. Validação das regras de negocio dos itens..............................................................................16
4.12.2.3. Final do processamento:..........................................................................................................17
4.13. atualizarCadastroProduto.....................................................................................................................18
4.13.1. Mensagem de entrada:................................................................................................................. 18
4.13.2. Processamento do envio...............................................................................................................18
4.13.2.1. Validações iniciais....................................................................................................................18
4.13.2.2. Validação das regras de negocio dos itens..............................................................................19
4.13.2.3. Final do processamento:..........................................................................................................19
4.14. Operação: autorizarPedidoProduto......................................................................................................20
4.15. Operação: incluirItensExtras................................................................................................................21
4.16. autorizarFaturamento............................................................................................................................ 22
4.16.1. Mensagem de entrada:................................................................................................................. 22
4.16.2. Processamento do envio...............................................................................................................23
4.16.2.1. Validações iniciais....................................................................................................................23
4.16.2.2. Validação das regras de negócio do cabeçalho do PDC..........................................................23
4.16.2.3. Validação das regras de negocio dos itens..............................................................................23
4.16.2.4. Final do processamento:..........................................................................................................23
4.17. listarResgateFornecedor....................................................................................................................... 24
5. WebServices Contrato/Catálogo...................................................................................................................... 24
5.1. listarProdutosContratosValidar................................................................................................................. 24
5.2. validarProdutosContrato........................................................................................................................... 25
6. Mensagens de Retorno.................................................................................................................................... 25
7. Fluxo Produtos................................................................................................................................................ 27
8. Fluxo OPMEnexo............................................................................................................................................ 28
9. Parâmetros....................................................................................................................................................... 30
9.1. Usuário...................................................................................................................................................... 30
9.2. Pedido....................................................................................................................................................... 30
10. Retornos...................................................................................................................................................... 31
11. Ambientes.................................................................................................................................................... 32
12. Abreviações utilizadas nas tabelas de layout:..............................................................................................33
1. Objetivo
Definir tecnologia utilizada para a troca eletrônica de informações. Especificar métodos utilizados para a comunicação entre os sistemas envolvidos e identificar possíveis retornos para os métodos consumidos. Apontar e demonstrar operações disponíveis. Definir ambientes para homologação para o desenvolvido da tecnologia assim como determinar o ambiente de produção que será utilizado.
2. Definição
A tecnologia a ser utilizada para a integração do sistema local do cliente com a plataforma OPMEnexo é baseada em SOAP WebServices em modelo canônico utilizando operações, parâmetros e retornos. Essas operações são invocadas pelos protocolos HTTP (porta 80) e HTTPS (porta 443) para a comunicação.
3. WebService WSPedido
O WebService de pedido utiliza o modelo do protocolo SOAP, que possui o seguinte layout:
# Nome Ele Pai Tipo Ocorr. Descrição
S01 env:Envelope Raiz Raiz do xml
S02 env:Header G 01 1-1 Grupo de informações de cabeçalho, não utilizado em WSPedido
S03 env:Body G 01 1-1 Grupo do corpo do XML
3.1. Layout de envio:Schema: WSPedido
Apesar do mesmo Schema ser utilizado para todas operações, cada operação possui apenas alguns parametros obrigatórios, que serão detalhados a frente.
3.2. Layout de Retorno:Schema: WSResposta
# Nome Ele Pai Tipo Ocorr. Descrição
01 ped:xxxxxxResponse G S03 Elemento raiz do dentro de env:Body onde xxxxxx é o nome da operação utilizada
02 return G 01 1-1 Grupo de informações do processamento
03 info E 02 C 1-1 Mensagem descrevendo o resultado do processamento
04 status E 02 N 1-1 Número de status do retorno
Cada operação possui seus respectivos retornos, estes se encontram detalhados a frente.
4. Operações As operações são definidas distintamente para cada serviço a ser executado pela
plataforma OPMEnexo. Abaixo, definição das operações e explicação do funcionamento junto as funções disponíveis na plataforma web.
4.1. Operação: “incluirPedido” –
Essa operação inclui um pedido na plataforma OPMEnexo, operação válida para procedimento e compra por produto. Quando o pedido é incluído, os fornecedores serão informados que devem efetuar cotação dos materiais ou procedimento cirúrgico. Após envio, a solicitação, ficará com status “Inicial“ na plataforma, sendo necessário ação do usuário para publicá-‐lo aos fornecedores.
Método: incluirPedido(Usuario, Pedido) Parâmetros requeridos: Usuário, Pedido (definição dos parâmetros no tópico 4.1)
Retorno: WSRespostaIncluirPedido (definição do retorno no tópico 10)
Layout envio: WSPedido.xml
# Nome Ele Pai Tipo Tamanho Obrig. Ocorr. Descrição
01 Pedido Raiz - - - - - Elemento raiz Pedido
02 Id_Pedido E 01 N - S 1-1 Id Pedido de referência gerado na plataforma OPMEnexo.Enviar conteúdo em branco para incluir pedido.
03 Cabecalho G 01 - - - 1-1 Elemento raiz dentro da tag Pedido. Contém grupo de tags do cabeçalho do pedido
04 Titulo_Pdc E 03 C 75 S 1-1 Título do pdc a ser exibido para os fornecedores na plataforma OPMEnexo
05 Contato E 03 C 75 S 1-1 Nome do comprador no Hospital
06 Id_Forma_Pagamento E 03 N - S 1-1 Id da forma de pagamento na plataforma OPME. Necessário realizar de-para no sistema local
07 Data_Vencimento E 03 D dd/mm/yyyy S 1-1 Data da vencimento do pedido para recebimento de cotações na plataforma OPMEnexo.
08 Hora_Vencimento E 03 H hh:mm S 1-1 Hora do vencimento da pedido para recebimento de cotações
09 Moeda E 03 C 3 N 1-1 Moeda utilizada para o pedido. Valor fixo “Reais“.
10 Observacao E 03 C 1500 N 1-1 Observações do comprador para o pedido
11 Termos_Condicoes E 03 C 1500 N 1-1 Termos e condições do comprador para o pedido
12 Cod_Procedimento E 03 C 75 S 1-1 Código do procedimento cadastrado na plataforma OPMEnexo.
13 Data_Procedimento E 03 D dd/mm/yyyy S 1-1 Data em que o procedimento será executado pelo hospital. A data deve ser igual ou maior à data de vencimento do pedido.
14 Hora_Procedimento E 03 H Hh:mm S 1-1 Se a data do procedimento for igual à data de vencimento, a hora do procedimento deve ser posterior à hora de vencimento do pedido.
15 Paciente E 03 C 75 S 1-1 Nome do paciente que está vinculado ao procedimento
16 Matricula E 03 C 30 N 1-1 Matricula do paciente no hospital
# Nome Ele Pai Tipo Tamanho Obrig. Ocorr. Descrição
17 Medico E 03 C 75 S 1-1 Nome do médico relacionado ao procedimento
18 CRM E 03 C 30 S 1-1 CRM do médico
19 CRM_UF E 03 C 2 S 1-1 Unidade federativa do CRM
20 Convenio E 03 N 150 S 1-1 Código do convêncio, enviar este em conjunto com o campo 21.
21 CNPJ_Convenio E 03 C 30 S 1-1 CNPJ do convênio relacionado ao código do campo 20
22 Cod_Endereco_Entrega E 03 C - N 1-1 Código do endereço de entrega
23 Cod_Agendamento E 03 C 75 N 1-1 Código do agendamento do procedimento
24 Requisicao E 03 C 75 N 1-1 Número da requisição gerada no sistema local
25 camposExtra G 03 - - N 1-1 Indica um grupo de tags de campos extras. Elemento raiz dentro da tag Cabecalho [03]
26 Campo_Extra E 25 - - S 1-N Elemento raiz dentro da tag raiz camposExtra [25]. Informações que não estão contempladas no layout mas devem ser retornadas para o sistema do gestão, devem ser informadas em campo extra
27 Nome E 25 C 30 S 1-1 Nome da tag de campo extra, pode ser inserido um nome definido no sistema local
28 Valor E 25 C 75 S 1-1 Valor informativo do campo extra cujo nome foi defininido na tag 27
29 Procedimentos_Adicionais G 03 - - N 1-1 Elemento raiz da tag Pedido [01]. Informar para o caso de haver mais de uma procedimento para o pedido
30 Procedimento_Adicional E 29 - - S 1-N Elemento raiz dentro da tag 29
31 Cod_Procedimento E 30 C 75 S 1-1 Código do procedimento adicional, diferente do informado na tag 12
33 Itens G 03 - - N 1-1 Tag raiz da tag 01 Pedido. Itens que farão parte do pedido para cotaçãoo
34 Item E 33 - - S 1-1 Tag raiz da tag 33
35 Cod_Produto E 34 C 30 S 1-1 Código do produto do hospital. O código deve estar previamente cadastro na plataforma OPMEnexo
36 Quantidade E 34 N - S 1-1 Quantidade do produto solicitado conforme unidade de medida
37 codTipoPedido E 01 C 1 S 1-1 Informar tipo do Pedido. K=Procedimento; P = Produto;R = Consignado; C = PDC p/ Contrato
4.2. Operação: “confirmarPedido”
Confirma a utilização de materiais em um pedido por procedimento. Quando efetuada essa operação, os fornecedores que estão no carrinho receberão a relação de itens utilizados (quando informado apenas ID do PDC). Os produtos que constam no pedido e estão respondidos, porém não constam no carrinho, podem ser enviados no arquivo de confirmação que serão confirmados normalmente.
Método: confirmarPedido (Usuario, Pedido)
Parâmetros requeridos: Usuario, Pedido (definição dos parâmetros no tópico 4.1)
Retorno: WSResposta (definição do retorno no tópico 7)
Layout envio: WSPedido.xml
# Nome Ele Pai Tipo Tamanho Obrig. Ocorr. Descrição
4.3. Operação: “alterarPedido”
Altera cabeçalho do pedido por procedimento na plataforma OPMEnexo. Deve-‐se enviar o layout com as informações completas do pedido (conteúdo). Os campos que serão alterados são: titulo, contato, id_forma_pagamento, id_endereco, dt_vencimento, observacoes, termos_condicoes, paciente, dt_procedimento, matricula, medico, crm, id_convenio.
Retorno: WSRespostaIncluirPedido
Layout envio: WSPedido.xml
# Nome Ele Pai Tipo Tamanho Obrig. Ocorr. Descrição
4.4. Operação: “autorizarPedido”
Autoriza o fornecedor que possui itens no carrinho a realizar a entrega do pedido.
Parâmetros requeridos: Usuario, Senha, ID_Pedido
Retorno: WSResposta Layout envio: ND
4.5. Operação: “cancelarPedido”
Cancela o pedido quando status for Pendente ou Autorizado. O fornecedor será notificado automaticamente (por e-‐mail) após cancelamento.
Parâmetros requeridos: ID_Pedido
Retorno: WSResposta
Layout: ND
4.6. Operação: “consultarStatusPedido”
Retorna o status do pedido.
Os possíveis status são: AGUARDANDO ENVIO; ENVIADO; VENCIDO; ENTREGA AUTORIZADA; FATURA AUTORIZADA PARCIALMENTE; FATURA AUTORIZADA; FATURA RECEBIDA PARCIALMENTE; FATURADO.
Parâmetro: ID_Pedido
Retorno: WSResposta
Layout: ND
4.7. Operação: “incluirItensCarrinho”
Inclui os itens no carrinho. Esta operação pode ser chamada após baixar respostas e obter informações dos itens cotados.
Parâmetros requeridos: Usuario, Pedido (definição dos parâmetros no tópico 4.1)
Retorno: WSResposta (definição do retorno no tópico 7)
Layout: WSPedido.xml
# Nome Ele Pai Tipo Tamanho Obrig. Ocorr. Descrição
01 Pedido G - - - - 1-1 Elemento raiz, contem tags com conteúdo das respostas
02 Id_Pedido E 01 N - - 1-1 ID do pedido na plataforma OPMEnexo
03 Cabecalho G 01 - - - 1-1 Tag que contém o conteúdo do cabeçalho do PDC
04 Titulo_Pdc E 03 C 75 - 1-1 Título do pdc na plataforma OPMEnexo
05 Data_Vencimento E 03 D dd/mm/yyyy - 1-1 Data da vencimento do pedido na plataforma OPMEnexo.
06 Hora_Vencimento E 03 H hh:mm - 1-1 Hora do vencimento da pedido para recebimento de cotações
07 Data_Procedimento E 03 D dd/mm/yyyy Data em que o procedimento foi executado.
08 Hora_Procedimento E 03 H hh:mm - 1-1 Hora que o procedimento foi executado
09 Paciente E 03 C 75 - 1-1 Nome do paciente
10 Matricula E 03 C 30 - 1-1 Matricula do paciente no hospital
11 Medico E 03 C 75 - 1-1 Nome do médico relacionado ao procedimento
12 CRM E 03 C 30 - 1-1 CRM do médico
13 CRM_UF E 03 C 2 - 1-1 Unidade federativa do CRM
14 CNPJ_Convenio E 03 C 18 - 1-1 CNPJ do convênio
26 Itens G 01 - - - 1-1 Tag raiz com os itens que os fornecedores responderam
27 item G 26 - - - 1-1 Tag raiz da tag itens [26]
28 Id_Artigo E 27 N - - 1-1 ID de Referência do ítem no pedido
29 Id_Marca E 27 N - - 1-1 ID da Marca do produto
30 Codigo_Produto E 27 C 30 - 1-1 Código do produto cotado
31 Quantidade E 27 N - - 1-1 Quantidade solicitada para o produto
32 Respostas E 27 - - - 1-1 Tag raiz da tag 27. Respostas dos fornecedores para o ítem
33 Resposta E 32 - - - 1-1 Tag raiz da tag 32
34 CNPJ E 33 C 30 - 1-1 CNPJ do fornecedor que cotou
35 Fabricante E 33 C 300 - 1-1 Fabricante do produto cotado pelo fornecedor
37 Preco_Unitario E 33 N - - 1-1 Preço unitário do produto informado pelo fornecedor
38 codTipoPedido E 01 C 1 S 1-1 Informar tipo do Pedido. K=Procedimento; P = Produto;R = Consignado; C = PDC p/ Contrato
4.8. Operação: “incluirPedidoReposicao”
Cria pedido de reposição. Quando houver mais de um contrato para o ítem, o pedido ficará como pendente na plataforma, caso contrário, o pedido de reposição será gerado automaticamente e o ID do PDC (deve-‐se enviar CNPJ do convênio no arquivo).
Parâmetros requeridos: Usuario, Pedido (definição dos parâmetros no tópico 4.1)
Retorno: WSRespostaIncluirPedido (definição do retorno no tópico 7)
Layout: WSPedido.xml
4.9. Operação: “listarCarrinho”
Lista os itens que foram adicionados ao carrinho.
Parâmetro: ID_Pedido
Layout Retorno: WSRespostaListarPedido.xml
4.10. Operação: listarRespostasPedido
Lista todas as respostas efetuadas por ítem
Parâmetro: ID_Pedido
Layout Retorno: WSRespostaListarPedido.xml
# Nome Ele Pai Tipo Tamanho Obrig. Ocorr. Descrição
01 pedido G - - - - 1-1 Elemento raiz, contem tags com conteúdo das respostas
02 Id_Pedido E 01 N - - 1-1 ID do pedido na plataforma OPMEnexo
03 Cabecalho G 01 - - - 1-1 Tag que contém o conteúdo do cabeçalho do PDC
04 Titulo_Pdc E 03 C 75 - 1-1 Título do pdc na plataforma OPMEnexo
05 Data_Vencimento E 03 D dd/mm/yyyy - 1-1 Data da vencimento do pedido na plataforma OPMEnexo.
06 Hora_Vencimento E 03 H hh:mm - 1-1 Hora do vencimento da pedido para recebimento de cotações
07 Data_Procedimento E 03 D dd/mm/yyyy Data em que o procedimento foi executado.
08 Hora_Procedimento E 03 H hh:mm - 1-1 Hora que o procedimento foi executado
09 Paciente E 03 C 75 - 1-1 Nome do paciente
10 Matricula E 03 C 30 - 1-1 Matricula do paciente no hospital
11 Medico E 03 C 75 - 1-1 Nome do médico relacionado ao procedimento
12 CRM E 03 C 30 - 1-1 CRM do médico
13 CRM_UF E 03 C 2 - 1-1 Unidade federativa do CRM
14 CNPJ_Convenio E 03 C 18 - 1-1 CNPJ do convênio
15 Fornecedores G 03 - - - - Elemento raiz da tag 01 pedido. Contém fornecedores que responderam o pedido
16 Fornecedor G 15 - - - - Elemento raiz da tag 15 Fornecedores
17 Nome_Fantasia E 16 C 150 Nome fantasia fornecedor
18 Razao_Social E 16 C 150 - 1-1 Razão Social Fornecedor
19 CNPJ E 16 C 30 - 1-1 CNPJ Fornecedor
20 Cod_Fornecedor E 16 C 30 - 1-1 Código do fornecedor vinculado na plataforma OPMEnexo
21 Faturamento_Minimo E 16 N - - 1-1 Faturamento mínimo informado na proposta do fornecedor
22 Prazo_Entrega E 16 N - - 1-1 Prazo de entrega informado pelo fornecedor a partir da confirmação
23 Validade_Proposta E 16 D dd/mm/yyyy - 1-1 Validade da proposta informada pelo fornecedor
24 Id_Forma_Pagamento E 16 N - - 1-1 Id da forma de pagamento informado pelo fornecedor na proposta
25 Frete E 16 C 3 - 1-1 CIF – FOB. Tipo de frete informado pelo fornecedor
26 Itens G 01 - - - 1-1 Tag raiz com os itens que os fornecedores responderam
27 item G 26 - - - 1-1 Tag raiz da tag itens [26]
28 Id_Artigo E 27 N - - 1-1 ID de Referência do ítem no pedido
29 Id_Marca E 27 N - - 1-1 ID da Marca do produto
# Nome Ele Pai Tipo Tamanho Obrig. Ocorr. Descrição
30 Codigo_Produto E 27 C 30 - 1-1 Código do produto cotado
31 Quantidade E 27 N - - 1-1 Quantidade solicitada para o produto
32 Respostas E 27 - - - 1-1 Tag raiz da tag 27. Respostas dos fornecedores para o ítem
33 Resposta E 32 - - - 1-1 Tag raiz da tag 32
34 CNPJ E 33 C 30 - 1-1 CNPJ do fornecedor que cotou
35 Fabricante E 33 C 300 - 1-1 Fabricante do produto cotado pelo fornecedor
36 Embalagem E 33 C 75 - 1-1 Embalagem do produto cotado pelo fornecedor
37 Preco_Unitario E 33 N - - 1-1 Preço unitário do produto
38 Preco_Total E 33 N - - 1-1 Preço total do produto (Preco_Unitario x Quanitdade)
39 Comentario E 33 C 300 - 1-1 Comentários do fornecedor para o produto
4.11. Operação: listarRespostasPedidoConfirmado
Lista somente os itens e fornecedores confirmados.
Parâmetro: Usuário, ID_Pedido
Layout Retorno: WSRespostaListarPedido.xml
4.12. listarCadastroProdutoLista informações cadastrais de todos itens do pedido solicitado.
Atualiza informações dos produtos. Operação utilizada quando há um novo produto cadastrado no sistema local. A operação deve ser chamada após operação listarProdutos.
4.12.1. Mensagem de entrada:
Schema XML : WsPedido.xsd
Parametros obrigatórios dentro de soapenv:Body:
# Nome Ele Pai Tipo Ocorr. Descrição
01 ped:listarCadastroProduto G S03 Elemento raiz do corpo
02 Usuario G 01 1-1 Grupo das informações de login
03 login E 02 C 1-1 Login do usuario
04 senha E 02 C 1-1 Senha do usuario
05 Id_Pedido E 01 N 1-1 ID do pedido a ser listado
4.12.2. Processamento do envio
4.12.2.1. Validações iniciais
# Regra de validação Msg. Result.
L01 Verifica se o usuario existe 001 Rejeição
L02 Verifica se o login e a senha estão corretos 002 Rejeição
L03 Verifica se o usuario está habilitado 003 Rejeição
L04 Verifica se a empresa do usuario está habilitada 004 Rejeição
P01 Verifica se o pedido solicitado pertence a empresa do usuário 005 Rejeição
4.12.2.2. Validação das regras de negocio dos itens
# Regra de validação Msg. Result.
I01 O pedido deve possuir itens 016 Rejeição
4.12.2.3. Final do processamento:
Caso tenha sido rejeitado em alguma regra que resulta em rejeição, o status retornado é -1, caso contrário o status é 1 e o retorno é um XML com schema WSProduto com os seguintes campos preenchidos:
01 ped:listarCadastroProdutoResponse
G S03 Elemento raiz do corpo
02 return G 01 1-1 Grupo das informações do retorno do metodo
03 Produtos G 02 1-N Grupo de informação do produto
04 Id_Produto E 03 N 1-1 ID do produto em OPMEnexo
05 Descricao_Produto_Marca E 03 C 1-1 Descrição do produto marca
06 Descricao_Produto E 03 C 1-1 Descrição do produto
07 Id_Marca E 03 N 1-1 ID da marca em OPMEnexo
08 Nome_Marca E 03 C 1-1 Nome da marca
09 Referencia E 03 C 1-1 Referencia do produto
10 Numero_Rms E 03 C 1-1 Numero RMS do produto
11 Data_Validade E 03 D 1-1 Data de validade do produto
12 Unidade_medida E 03 C 1-1 Unidade de medida
13 Codigo_Produto E 03 C 1-1 Código do produto
14 Preco_Referencia E 03 ND 1-1 Preço de referencia do produto
15 Preco_Inicial E 03 ND 1-1 Primeiro preço deste produto
4.13. atualizarCadastroProdutoAtualiza informações dos produtos. Operação utilizada quando há um novo produto cadastrado no sistema local. A operação deve ser chamada após operação listarProdutos.
4.13.1. Mensagem de entrada:
Schema XML : WsPedido.xsd
Parametros obrigatórios dentro de soapenv:Body:
# Nome Ele Pai Tipo Ocorr. Descrição
01 ped:autorizarFaturamento G S03 Elemento raiz do corpo
02 Usuario G 01 1-1 Grupo das informações de login
03 login E 02 C 1-1 Login do usuario
04 senha E 02 C 1-1 Senha do usuario
05 Pedido G 01 1-1 Grupo das informações do pedido
06 Id_Pedido E 05 N 1-1 ID do pedido onde estão os produtos
07 Itens G 05 1-1 Grupo dos itens do pedido
08 item G 07 1-N Informações individuais dos itens
09 ID_Artigo E 08 N 1-1 ID do Produto em OPME
10 Codigo_Produto E 08 C 1-1 Novo código do produto
11 Respostas G 08 1-1 Informações sobre a resposta do item
12 CNPJ E 11 C 1-1 CNPJ do fornecedor da resposta
4.13.2. Processamento do envio
4.13.2.1. Validações iniciais
# Regra de validação Msg. Result.
L01 Verifica se o usuario existe 001 Rejeição
L02 Verifica se o login e a senha estão corretos 002 Rejeição
L03 Verifica se o usuario está habilitado 003 Rejeição
L04 Verifica se a empresa do usuario está habilitada 004 Rejeição
P01 Verifica se o pedido passado pertence a empresa do usuario 005 Rejeição
4.13.2.2. Validação das regras de negocio dos itens
# Regra de validação Msg. Result.
I01 Verifica se dois itens foram atualizados simultaneamente 013 Aviso / A
I02 Verifica se ocorreu algum erro desconhecido durante a atualização do item 014 Rejeição / NA
I03 Caso o produto não pertença ao PDC 015 Aviso / NA
Legenda do resultado:
NA - Não atualiza o item
A - Atualiza o item
4.13.2.3. Final do processamento:
Caso tenha sido rejeitado em alguma regra que resulta em rejeição, o status retornado é -1, caso contrário o status é 1 e a Info do retorno é um dos descritos a seguir concatenados com as mensagens de aviso.
# Regra de validação Msg. Result.
F01 Algum produto teve seu código alterado com sucesso 016 OK
4.14. Operação: autorizarPedidoProduto
Autoriza a entrega somente dos produtos enviados no XML. Diferente da operação autorizarPedido que autoriza o pedido na sua totalidade, esta operação autoriza somente os itens que constam no XML.
Parâmetro: Usuário, Pedido
Retorno: WSResposta
Layout envio: WSPedido.xml
4.15. Operação: incluirItensExtras
Incluir itens não autorizados no pedido. Verifica se havia cotação prévia, caso não, dispara comunicado para o fornecedor.
Parâmetros requeridos: Usuario, Pedido (definição dos parâmetros no tópico 4.1)
Retorno: WSResposta (definição do retorno no tópico 7)
Layout envio: WSPedido.xml
4.16. autorizarFaturamentoSinaliza ao fornecedor que pode faturar o pedido dos itens utilizados. Necessário solicitar
autorização/liberação para operação Autorizar. Esta operação deve ser acionada após confirmação do uso.
4.16.1. Mensagem de entrada:
Schema XML : WsPedido.xsd
Parametros obrigatórios dentro de soapenv:Body:
# Nome Ele Pai Tipo Ocorr. Descrição
01 ped:autorizarFaturamento G S03 Elemento raiz do corpo
02 Usuario G 01 1-1 Grupo das informações de login
03 login E 02 C 1-1 Login do usuario
04 senha E 02 C 1-1 Senha do usuario
05 Pedido G 01 1-1 Grupo das informações do pedido
06 Id_Pedido E 05 N 1-1 ID do pedido a ser autorizado
07 Itens G 05 1-1 Grupo dos itens do pedido
08 item G 07 1-N Informações individuais dos itens
09 Codigo_Produto E 08 C 1-1 Codigo do produto
10 Campos_Extra G 08 0-N Campos extra
11 Nome E 10 C 0-1 Caso existir, passar “CNPJ_Fatura” como nome do campo
Regra de faturamento:
CNPJ_Fatura preenchida: Pode estar preenchido com o CNPJ do convenio ou do comprador, e será faturado para a empresa respectiva. Caso esteja preenchida incorretamente, não será faturado.
CNPJ_Fatura não preenchida: Fatura para o comprador
12 Valor E 10 C 0-1 CNPJ do convenio ou comprador que o item será faturado
13 Respostas G 08 1-1 Informações sobre a resposta do item
14 CNPJ E 13 C 1-1 CNPJ do fornecedor da resposta
4.16.2. Processamento do envio
4.16.2.1. Validações iniciais
# Regra de validação Msg. Result.
L01 Verifica se o usuario existe 001 Rejeição
L02 Verifica se o login e a senha estão corretos 002 Rejeição
L03 Verifica se o usuario está habilitado 003 Rejeição
L04 Verifica se a empresa do usuario está habilitada 004 Rejeição
P01 Verifica se o pedido passado pertence a empresa do usuario 005 Rejeição
4.16.2.2. Validação das regras de negócio do cabeçalho do PDC
# Regra de validação Msg. Result.
C01 Status do pedido deve ser confirmado ou faturado parcialmente. 006 Rejeição
C02 Cotação deve estar vencida. 007 Rejeição
4.16.2.3. Validação das regras de negocio dos itens
# Regra de validação Msg. Result.
I01 CNPJ_Fatura deve estar preenchido com o CNPJ do comprador ou do convenio
008 Aviso
4.16.2.4. Final do processamento:
Caso tenha sido rejeitado em alguma regra que resulta em rejeição, o status retornado é -1, caso contrário o status é 1 e a Info do retorno é um dos descritos a seguir concatenados com as mensagens de aviso.
# Regra de validação Msg. Result.
F01 O usuario necessita de aprovação de um usuario superior (Alçadas) 009 OK
F02 O pedido foi faturado parcialmente (restaram itens não faturados no pedido) 010 OK
F03 O pedido foi faturado totalmente 011 OK
F04 Nenhum produto foi faturado (caso os itens passados não estejam no pedido
012 OK
4.17. listarResgateFornecedor
Retorna quais fornecedores resgataram ou não o pedido.
Retorno: Retorno_listarResgateFornecedor.xml
Parametros de envio obrigatórios dentro de soapenv:Body:
# Nome Ele Pai Tipo Ocorr. Descrição
01 ped:listarResgateFornecedor G S03 Elemento raiz do corpo
02 Usuario G 01 1-1 Grupo das informações de login
03 login E 02 C 1-1 Login do usuario
04 senha E 02 C 1-1 Senha do usuario
05 Id_Pedido E 05 N 1-1 ID do pedido a ser consultado
5. WebServices Contrato/Catálogo
5.1. listarProdutosContratosValidar
Retorna os itens que foram adicionados ao contrato e que devem ser validados/homologados no sistema local.
Retorno: Retorno_listarProdutosContratosValidar.xml
Parâmetros de envio obrigatórios dentro de soapenv:Body:
5.2. validarProdutosContrato
# Nome Ele Pai Tipo Ocorr. Descrição
01 ped: listarProdutosContratosValidar G S03 Elemento raiz do corpo
02 Usuario G 01 1-1 Grupo das informações de login
03 login E 02 C 1-1 Login do usuario
04 senha E 02 C 1-1 Senha do usuario
Valida os itens baixados e que ainda estão em homologação. As possíveis ações são: R=Recusado; A=Aceito; B=Baixado.
ENVIO: ENVIO_VALIDARPRODUTOSCONTRATO.XML
Retorno: validarProdutosContratoResponse (definição do retorno no tópico 10) Parâmetros de envio obrigatórios dentro de soapenv:Body:
# Nome Ele Pai Tipo Ocorr. Descrição
01 con:validarProdutosContrato G S03 Elemento raiz do corpo
02 Usuario G 01 1-1 Grupo das informações de login
03 login E 02 C 1-1 Login do usuário
04 senha E 02 C 1-1 Senha do usuário
05 Validacao_Produtos_Contrato G 01
06 Solicitacao G 05 1-N
07 Id_Solicitacao_Contrato E 06 N 1-1 Número de controle por ítem retornado no método listarProdutosContratosValidar
08 Justificativa C[3500] 1-1 Informar apenas quando for recusa “R“. Motivo da recusa do ítem.
09 Acao C[1] 1-1
Informar a ação desejada:
R=Recusado;A=Aceito;B=Baixado.
10 Produto 1-1
11 Codigo_Produto C[30] 1-1
Código do produto no sistema local. Para produtos em homologação, o Hospital deve enviar o código no momento de validar/aceitar os produtos no contrato.
Para os pontos 5.1 e 5.2, utilizar URLs de Contrato descritas no fim do arquivo.
6. Mensagens de Retorno
# Mensagem
001 Usuário invalido
002 Senha incorreta
003 O usuário não está habilitado
004 A empresa não está habilitada
005 O pedido não pertence a sua empresa
006 O pedido não está com status 'confirmado' ou 'fatura autorizada parcialmente'.
007 A cotação do pedido ainda não venceu
008 Ítem <Codigo do Item> do fornecedor <CNPJ do Fornecedor> não foi faturado devido a inconsistencia no cnpj informado(<CNPJ Fatura informado>).
009 Pedido será enviado para aprovação de alçada.
010 Pedido faturado parcialmente com sucesso.
011 Pedido faturado com sucesso.
012 O PDC não foi faturado pois nenhum produto informado pode ter seu faturamento autorizado.
013 Erro ao tentar atualizar produto de ID '<idProduto>' para o codigo '<codigoProduto>'.
014 Erro durante a atualização dos produtos.
015 Produto de ID '<idProduto>' e codigo para ser alterado '<codigoProduto>' não pertence ao pedido.
016 A cotação não possui itens
7. Fluxo Produtos
8. Fluxo OPMEnexo
9. Parâmetros Os parâmetros são fixos para todas as operações e estão localizados dentro do corpo do envelope principal. Eles são compostos pelas informações de usuário e pedido. Abaixo segue detalhamento:
9.1. Usuário
A estrutura utilizada para o envio de usuário e senha é XML. O Usuário e senha mencionado, deve estar devidamente cadastrado na plataforma OPMEnexo com privilégios de acesso ao WebServices. Exemplo: <Usuario> <login>Teste-‐OPMEnexo</login> <senha>testando11</senha> </Usuario>
9.2. Pedido
A estrutura utilizada para o envio de pedido é XML. Os campos a serem preenchidos no pedido devem ser pertinentes a operação que está sendo utilizada. Todas as tags do pedido não são obrigatórias, porém, devem ser preenchidas ao máximo pelo sistema conector. Caso exista uma tag essencial para a operação solicitada e a mesma não ser devidamente preenchida, o sistema deverá retornar erro ou nulo.
(conforme tópico retorno)
Exemplos: Enviado separadamente em estrutura XSD e XML.
10. Retornos
A Webservices OPMEnexo tem sua estrutura de comunicação síncrona. Isso significa que para qualquer operação solicitada existirá um retorno. Esse retorno sinalizará se a operação foi bem concluída ou não e tem o formato XML. Ele é composto por três informações:
- INFO: Mensagem do sistema referente a operação solicitada;
- PEDIDO: Estrutura de pedido, enviado separadamente em XSD e XML – Ele é retornado quando a operação é do tipo lista;
- ID_PEDIDO: Somente a tag Id_Pedido. Ele é retornado quando a operação é do tipo incluir, alterar, confirmar e autorizar.
- STATUS: Status do sistema referente a operação solicitada, possíveis status:
status < 0 = ERROR – Erro durante o processamento da operação;
status > 0 = OK – OK, operação bem realizada;
status = 0 = null – Operação ou contexto de mensagem enviada inexistente.
Exemplo:
<return>
<info>Usuário Inválido.</info>
<status>-‐1</status>
<pedido>0</pedido>
</return>
11. Ambientes Homologação: Ambiente com acesso restrito somente utilizado para homologação do
desenvolvimento efetuado com prévio prazo de utilização acordado. Ambiente utilizado também para homologar pacotes de desenvolvimento que o pode por motivos alheios ao aqui abordado parar sua operação por curto período de tempo. O usuário e senha para acesso a esse ambiente será enviado separadamente após todos os tramites comerciais serem cumpridos.
URLs de homologação para Pedidos:
URL: https://sandbox.opmenexo.com.br/ws/WSPedido
WSDL: https://sandbox.opmenexo.com.br/ws/WSPedido?wsdl
URLs de homologação para Contratos:
URL: https://sandbox.opmenexo.com.br/ws/WSContrato
WSDL: https://sandbox.opmenexo.com.br/ws/WSContrato?wsdl
Produção: Ambiente com acesso restrito e somente disponibilizado após homologação ser documentada por ambas as partes. Ambiente real de alta disponibilidade. Toda e qualquer informação imputada nele é de total responsabilidade de seu autor. O usuário e senha para acesso a esse ambiente será passado separadamente após homologação efetuada e os tramites comerciais serem cumpridos.
URLs de produção para Pedidos:
URL: (com SSL): https://www.opmenexo.com.br/ws/WSPedido
URL validadora (com SSL): https://www.opmenexo.com.br/ws/WSPedido?wsdl
URLs de produção para Contratos:
URL: (com SSL): https://www.opmenexo.com.br/ws/WSContrato
URL validadora (com SSL): https://www.opmenexo.com.br/ws/WSContrato?wsdl
12. Abreviações utilizadas nas tabelas de layout:
#: Identificação numérica para uso na documentação
Nome: Nome do campo
Ele: Tipo do campo, pode ser um dos seguintes:
● E : Indica que o campo é um Elemento● G : Indica que o campo é um Grupo de elementos● A : Indica que o campo é um atributo de um elemento
Pai: Elemento pai do elemento atual
Tipo: Tipo do conteúdo do campo, pode ser um dos seguintes:
● C : Campo alfanumérico● N : Campo numérico● D : Campo data.● ND : Campo numérico decimal (fromato NNNNNNNNNN,NN)
Ocorr. : x-y, onde x indica a ocorrência mínima e y a ocorrência máxima
Descrição : Descrição do campo