2023
Cadastro de Séries via API
23 de março de 2023Olá! Nesse artigo iremos explicar sobre como realizar o cadastro de séries via API através da comunicação com o Web Service arecepcao.aspx disponibilizado pelo InvoiCy.
Com o mesmo XML estruturado para realizar essa operação, será possível inserir, alterar, excluir ou até mesmo consultar uma determinada série na plataforma.
– Envio do cadastro de série via API SOAP:
Para realizar a inclusão de uma nova série, você deverá enviar toda a estrutura do XML de envio dentro da tag ‘Documentos’ convertido para texto, como demonstra a imagem.
Para obter o layout de envio do cadastro de série, faça o download do arquivo CadastroSerie.zip, nele você encontrará também um arquivo XML de exemplo.
– Consulta de Série:
É possível consultar a série que foi cadastrada, permitindo ao usuário ter a certeza de que a mesma foi cadastrada corretamente.
Para isso basta enviar a seguinte estrutura, conforme demonstra a imagem abaixo, informando a operação que deseja efetuar e as informações da série.
Clique aqui para fazer download do modelo de XML de envio e retorno da consulta da série.
– Alteração de Série:
Também poderá ser realizada a alteração de uma série já cadastrada no InvoiCy.
Para baixar o layout de envio e retorno de alteração e um exemplo completo do XML clique aqui.
– Exclusão de Série:
Para realizar a exclusão da série cadastrada no InvoiCy, é necessário enviar a estrutura conforme demonstra a próxima imagem, informando a operação “E”.
Clique aqui para baixar o layout de envio e retorno de exclusão e um exemplo completo do XML.
– Envio do Cadastro de Séries via API REST:
O envio do cadastro de série e demais operações possíveis via API REST, poderão ser realizadas através do endpoint “acompanies”.
Acesse aqui a documentação e exemplos de integração REST.