Definição
WS-I Basic Profile é um conjunto de regras técnicas que orienta como web services baseados em SOAP, WSDL e XML devem ser construídos para que sistemas diferentes consigam se comunicar sem incompatibilidades. Ele serve de referência para serviços governamentais, como os web services das SEFAZ usados na emissão e consulta de documentos fiscais eletrônicos.
Também conhecido como: WS-I BP, WS-I Basic Profile, Basic Profile, Perfil Básico WS-I
O que é o WS-I Basic Profile?
O WS-I Basic Profile é uma especificação publicada pela WS-I, sigla de Web Services Interoperability Organization, um consórcio da indústria de tecnologia criado para melhorar a compatibilidade entre web services. A palavra profile, ou perfil, indica que ele não cria uma tecnologia nova: ele escolhe como usar tecnologias que já existem.
Padrões como SOAP, WSDL e XML Schema são amplos e permitem várias interpretações. Na prática, isso fazia com que um serviço feito em uma linguagem de programação não funcionasse bem com um cliente feito em outra. O Basic Profile reduz essas ambiguidades, dizendo o que é obrigatório, o que é recomendado e o que deve ser evitado.
Para que serve o WS-I Basic Profile?
Ele serve para garantir interoperabilidade, ou seja, a capacidade de sistemas diferentes trocarem mensagens de forma previsível. Um ERP escrito em Java, um software de gestão em C# e uma plataforma em PHP podem consumir o mesmo web service se todos seguirem as mesmas regras.
Para quem integra com órgãos públicos, isso significa menos surpresas: o formato das mensagens, a forma de descrever o serviço e o jeito de transmitir os dados seguem um padrão conhecido, documentado e suportado pelas principais ferramentas de desenvolvimento.
Como funciona o WS-I Basic Profile na prática?
O perfil estabelece regras sobre como montar o envelope SOAP, como escrever o arquivo WSDL que descreve o serviço, como usar XML Schema para definir os dados e como transportar as mensagens via HTTP ou HTTPS.
Um exemplo comum é a preferência pelo estilo document/literal, em que o corpo da mensagem é um documento XML validado por um esquema, em vez de formatos de codificação mais antigos e menos padronizados. Também há regras sobre cabeçalhos, códigos de resposta HTTP e tratamento de erros por meio de mensagens SOAP Fault.
Qual a relação do WS-I Basic Profile com a NF-e e outros documentos fiscais?
Os web services das Secretarias da Fazenda usados para autorizar, cancelar e consultar documentos como NF-e, NFC-e, CT-e e MDF-e são baseados em SOAP e XML. Os manuais técnicos desses documentos citam o WS-I Basic Profile como referência de padronização da comunicação.
Por isso, quem desenvolve uma integração direta com a SEFAZ precisa lidar com envelopes SOAP, arquivos WSDL, esquemas XML, certificado digital na conexão HTTPS e assinatura digital do XML. Pequenos desvios nessas regras costumam gerar falhas de comunicação ou rejeições difíceis de diagnosticar.
Qual a diferença entre seguir o WS-I Basic Profile e usar uma API REST fiscal?
O Basic Profile trata de web services SOAP, em que tudo é XML e a descrição do serviço fica em um WSDL. APIs REST costumam usar JSON, métodos HTTP simples e endpoints mais diretos, o que tende a ser mais fácil para desenvolvedores atuais.
Uma API fiscal como a do Conota recebe os dados em JSON pelo sistema do cliente e cuida da comunicação SOAP com os órgãos autorizadores. Assim, a empresa não precisa implementar diretamente as exigências do Basic Profile, embora elas continuem existindo na comunicação com o fisco.
Exemplos de WS-I Basic Profile
- Um desenvolvedor que integra o ERP da empresa diretamente com a SEFAZ gera as classes de cliente a partir do WSDL do serviço de autorização da NF-e, confiando que ele segue o WS-I Basic Profile.
- Uma equipe recebe erros de comunicação ao chamar o web service de consulta de status e descobre que o envelope SOAP montado manualmente não respeitava o estilo document/literal esperado.
- Uma plataforma de vendas troca a integração SOAP própria por uma API REST de emissão fiscal, deixando para o provedor a conformidade com o WS-I Basic Profile e os esquemas XML oficiais.
- Um software de gestão valida suas mensagens com ferramentas de teste de interoperabilidade antes de levá-las do ambiente de homologação para o ambiente de produção.
Perguntas frequentes
O WS-I Basic Profile é uma lei ou norma fiscal?
Não. É uma especificação técnica de tecnologia, criada para padronizar web services. Ela aparece no contexto fiscal porque os serviços da SEFAZ adotam esse padrão como referência para a comunicação com os sistemas das empresas.
Preciso conhecer o WS-I Basic Profile para emitir notas fiscais?
Só se for integrar diretamente com os web services SOAP do fisco. Ao usar uma API fiscal que recebe JSON, como a do Conota, essa camada é tratada pelo provedor e o sistema da empresa não lida com SOAP.
O WS-I Basic Profile vale para APIs REST?
Não. Ele foi pensado para web services baseados em SOAP, WSDL e XML. APIs REST seguem outras convenções, normalmente usando JSON, métodos HTTP e documentação própria, sem depender desse perfil.
Atualizado em · Como produzimos este glossário
