Integração via API REST no InvoiCy

Rodrigo Artus

Analista e Consultor de Negócios da Migrate. Graduado em Análise e Desenvolvimento de Sistemas, é responsável pela evolução dos produtos InvoiCy e estreitamento do relacionamento com Parceiros!

2 Comments

Sim, caro desenvolvedor! É isso mesmo que você está pensando. Além da habitual integração via SOAP (XML) que disponibilizamos na plataforma InvoiCy, desenvolvemos uma API REST (JSON) para integração com a Plataforma (módulos NF-e, NFC-e e NFS-e), formato muito solicitado pela comunidade de desenvolvedores.

E para você que já quer ir se familiarizando com esta tecnologia, vamos através deste artigo falar um pouco sobre o seu significado, benefícios e de forma geral, esplanar como serão disponibilizadas as API’s REST para integração na Plataforma. 

Para você que já está integrado com nossos Web Services SOAP e familiarizado com este formato de integração, não se preocupe. Nada será afetado neste modelo, e você não vai precisar realizar sua integração novamente. Nossa plataforma tem a possibilidade de integração tanto via Web Service SOAP, como via REST, sendo mais uma opção de escolha no momento da integração de seu ERP conosco.

Mas afinal, o que é REST?

REST, está diretamente ligada ao desenvolvimento de aplicações WEB, que fazem comunicação através do protocolo HTTP (Hypertext Transfer Protocol). A palavra REST é um acrônimo da palavra em inglês “REpresentational State Transfer” (Transferência de Estado Representacional). REST, é um estilo de arquitetura para desenvolvimento de Web Services e API’s.

O REST foi criado por Roy Fielding em sua tese de doutorado. Fielding, também é um dos principais autores sobre as especificações do protocolo HTTP, esteve envolvido no desenvolvimento do HTML e de URI’s, sendo tambem cofundador do Apache HTTP Server.

Quando uma solicitação REST é realizada, o servidor irá enviar ao cliente uma representação dos estados que foram requeridos. Um exemplo prático, seria o consumo de uma API do Facebook, por exemplo, onde é possível requisitar dados de um determinado perfil, e como resposta, o servidor retorna as informações solicitadas, de maneira estruturada e padronizada, como número de seguidores, informações de contato, entre outras informações disponíveis para consulta através da API.

Mas, uma requisição REST nao serve somente para consultar e enviar informações. É possível também realizar ações como, inserir um novo registro ou até mesmo excluir um registro já existente. Em resumo, REST é utilizado como um padrão para realizar troca de informações entre aplicações, utilizando como base o protocolo HTTP e os métodos GET, POST, PUT e DELETE.

O que significam os métodos GET, POST, PUT e DELETE?

O método GET e um dos métodos mais utilizados. Ele é utilizado para realizar consultas no servidor, ou seja, sempre que você acessar uma página na internet, por exemplo, estará realizando uma consulta ao servidor pelo método GET, que por sua vez, retornará as informações da página que serão exibidas em sua tela. No InvoiCy, o método GET poderá ser utilizado para consulta de informações disponíveis na base de dados da Plataforma.

Já o método POST, é utilizado para enviar informações ao servidor. Este será o método utilizado pelos ERPs para envio de documentos fiscais ao InvoiCy, por exemplo. 

O método PUT, por sua vez, é utilizado para atualização de informações. Num exemplo prático, poderia ser utilizado para atualização do cadastro de uma empresa disponível na base de dados do InvoiCy, por exemplo.

Por fim, o DELETE, é o método utilizado para remover alguma informação de uma base de dados do servidor, ou até mesmo apagar algum tipo de arquivo.

Quais são as vantagens?

Uma das principais vantagens do REST, é a utilização de uma sintaxe universal para identificação dos recursos, ou seja, as URIs, que por fim, utilizam as mime-types ou content-types (tipos de conteúdo), para solicitar e retornar o conteúdo num formato padronizado. O mime-type mais utilizado na atualidade, sem sombra de dúvidas, é o JSON, que será, inclusive, o padrão utilizado nas API REST do InvoiCy.

No REST, sempre que uma requisição HTTP é realizada, alguns códigos serão retornados como resultado da requisição, como por exemplo, o famoso 404, que representa um erro de pagina nao encontrada. Já o código 200, indica que a requisição ocorreu com sucesso. 201 (Created), indica que uma informação enviada foi salva em um banco de dados, por exemplo. Também podemos citar o retorno 401 (Unauthorized), que indica uma falha na autenticação do serviço, e o 405 (Method Not Allowed), indica que uma operação realizada não é permitida pelo servidor, como um delete por exemplo. Estes são apenas alguns dos principais retornos, mas é possível verificar uma lista contendo vários códigos clicando aqui.

Nao deixe de acessar o portal em https://desenvolvedores.migrate.info/ e para receber todos os conteúdos postados em nosso portal, clique em “Seguir” no canto inferior direito da página:

Desta forma, qualquer conteúdo postado no portal será diretamente enviado para seu e-mail.

CLIQUE AQUI PARA ACESSAR O MATERIAL TÉCNICO

Gostou deste conteúdo? Então não deixe de compartilhar em suas redes sociais.

Rodrigo Artus

Analista e Consultor de Negócios da Migrate. Graduado em Análise e Desenvolvimento de Sistemas, é responsável pela evolução dos produtos InvoiCy e estreitamento do relacionamento com Parceiros!

Posted in:
About the Author

Rodrigo Artus

Rodrigo Artus

Analista e Consultor de Negócios da Migrate. Graduado em Análise e Desenvolvimento de Sistemas, é responsável pela evolução dos produtos InvoiCy e estreitamento do relacionamento com Parceiros!

2 Comments

  1. Mas vamos testar isso já! 🙂 Muito bom.

    • Perfeito Bruno! 😀
      Qualquer dúvida nos chame!

Deixe uma resposta

O seu endereço de e-mail não será publicado. Campos obrigatórios são marcados com *