Entendendo APIs
06/11/2024
0
alguém poderia me explicar melhor o que são APIs e como funcionam na prática ? por gentileza
Henrique Michelin
Curtir tópico
+ 0
Responder
Post mais votado
13/11/2024
uma API é uma função disponibilizada na web.
o retorno - se houver - pode ser um JSON ou um XML
por exemplo:
a nota fiscal eletrônica é tratada a partir de WebServices disponibilizado pela secretaria da fazenda estadual (e também pela receita federal).
então há endpoints (APIs) para recepcionar a NFe, para inutilizar NFe, para consultar, etc.
então você envia os dados/parâmetros solicitados, a API efetuará o processamento necessário e, se for o caso, dará o retorno daquele processamento.
outro exemplo: consultar um CEP
https://viacep.com.br/ws/01001000/json/
ele vai consultar a base de CEP do site viacep.com.br e retornar um JSON com as informações encontradas.
o link acima retorna um dado real (veja em https://viacep.com.br/). você pode trocar 01001000 pelo teu CEP e fazer o teste.
alguns WebServices NÃO apresentam o retorno imediato do processamento da API, então você terá que consumir uma API para efetuar a solicitação e depois uma outra API para obter o retorno daquela solicitação.
algumas APIs solicitam credenciais para que seja possível consumi-las; algumas solicitam usuário. senha, token, etc, outras requerem um certificado digital e ainda há aquelas - exemplo:ViaCEP - que não necessitam de credenciais.
as linguagens de programação possuem os recursos necessários para criar APIs e também para consumí-las (o termo utilizado quando se utiliza uma API é 'consumir'). você terá as funções/métodos para criar o XML/JSON ou até mesmo montar a URI necessária, bem como fazer a leitura do retorno, seja ele um XML ou um JSON.
o retorno - se houver - pode ser um JSON ou um XML
por exemplo:
a nota fiscal eletrônica é tratada a partir de WebServices disponibilizado pela secretaria da fazenda estadual (e também pela receita federal).
então há endpoints (APIs) para recepcionar a NFe, para inutilizar NFe, para consultar, etc.
então você envia os dados/parâmetros solicitados, a API efetuará o processamento necessário e, se for o caso, dará o retorno daquele processamento.
outro exemplo: consultar um CEP
https://viacep.com.br/ws/01001000/json/
ele vai consultar a base de CEP do site viacep.com.br e retornar um JSON com as informações encontradas.
o link acima retorna um dado real (veja em https://viacep.com.br/). você pode trocar 01001000 pelo teu CEP e fazer o teste.
alguns WebServices NÃO apresentam o retorno imediato do processamento da API, então você terá que consumir uma API para efetuar a solicitação e depois uma outra API para obter o retorno daquela solicitação.
algumas APIs solicitam credenciais para que seja possível consumi-las; algumas solicitam usuário. senha, token, etc, outras requerem um certificado digital e ainda há aquelas - exemplo:ViaCEP - que não necessitam de credenciais.
as linguagens de programação possuem os recursos necessários para criar APIs e também para consumí-las (o termo utilizado quando se utiliza uma API é 'consumir'). você terá as funções/métodos para criar o XML/JSON ou até mesmo montar a URI necessária, bem como fazer a leitura do retorno, seja ele um XML ou um JSON.
Emerson Nascimento
Responder
Gostei + 1
Mais Posts
19/11/2024
Arthur Heinrich
O conceito de API (Application Programming Interface) é como uma página de internet, que atua como uma interface de usuário. Porém, sem a interatividade que um usuário necessita. É uma interface que dá acesso a determinado recurso ou serviço, de forma que possa ser acionada através de um programa.
Você pode utilizar interfaces como esta para que um sistema grande possa ser dividido, o que é chamado de desacoplamento.
Uma vez que sua API foi testada, não é necessário testar todo o sistema que a utiliza. Além disso, permite que você modifique a forma como a interface funciona internamente e, sendo mantida a "interface", aplicações que a utilizam não são afetadas.
Existem inúmeras vantagens de se utilizar uma API, porém, também existem problemas, geralmente ligados à performance. Geralmente são mais úteis em aplicações do tipo OLTP, mas não ajudam muito em processos batch, que manipulam grandes volumes de dados.
Na prática, tudo em programação é uma API. Ao executar uma rotina, o que você faz é chamar a interface desta rotina. Para tanto, você precisa conhecer os parâmetros de entrada e o resultado esperado para poder utilizar a rotina e é isto que é a interface, entre a rotina e seu usuário. Através da interface, você pode fazer uso de algo complexo, sem no entanto entender como ela funciona.
Você pode utilizar interfaces como esta para que um sistema grande possa ser dividido, o que é chamado de desacoplamento.
Uma vez que sua API foi testada, não é necessário testar todo o sistema que a utiliza. Além disso, permite que você modifique a forma como a interface funciona internamente e, sendo mantida a "interface", aplicações que a utilizam não são afetadas.
Existem inúmeras vantagens de se utilizar uma API, porém, também existem problemas, geralmente ligados à performance. Geralmente são mais úteis em aplicações do tipo OLTP, mas não ajudam muito em processos batch, que manipulam grandes volumes de dados.
Na prática, tudo em programação é uma API. Ao executar uma rotina, o que você faz é chamar a interface desta rotina. Para tanto, você precisa conhecer os parâmetros de entrada e o resultado esperado para poder utilizar a rotina e é isto que é a interface, entre a rotina e seu usuário. Através da interface, você pode fazer uso de algo complexo, sem no entanto entender como ela funciona.
Responder
Gostei + 1
19/11/2024
Henrique Michelin
uma API é uma função disponibilizada na web.
o retorno - se houver - pode ser um JSON ou um XML
por exemplo:
a nota fiscal eletrônica é tratada a partir de WebServices disponibilizado pela secretaria da fazenda estadual (e também pela receita federal).
então há endpoints (APIs) para recepcionar a NFe, para inutilizar NFe, para consultar, etc.
então você envia os dados/parâmetros solicitados, a API efetuará o processamento necessário e, se for o caso, dará o retorno daquele processamento.
outro exemplo: consultar um CEP
https://viacep.com.br/ws/01001000/json/
ele vai consultar a base de CEP do site viacep.com.br e retornar um JSON com as informações encontradas.
o link acima retorna um dado real (veja em https://viacep.com.br/). você pode trocar 01001000 pelo teu CEP e fazer o teste.
alguns WebServices NÃO apresentam o retorno imediato do processamento da API, então você terá que consumir uma API para efetuar a solicitação e depois uma outra API para obter o retorno daquela solicitação.
algumas APIs solicitam credenciais para que seja possível consumi-las; algumas solicitam usuário. senha, token, etc, outras requerem um certificado digital e ainda há aquelas - exemplo:ViaCEP - que não necessitam de credenciais.
as linguagens de programação possuem os recursos necessários para criar APIs e também para consumí-las (o termo utilizado quando se utiliza uma API é 'consumir'). você terá as funções/métodos para criar o XML/JSON ou até mesmo montar a URI necessária, bem como fazer a leitura do retorno, seja ele um XML ou um JSON.
o retorno - se houver - pode ser um JSON ou um XML
por exemplo:
a nota fiscal eletrônica é tratada a partir de WebServices disponibilizado pela secretaria da fazenda estadual (e também pela receita federal).
então há endpoints (APIs) para recepcionar a NFe, para inutilizar NFe, para consultar, etc.
então você envia os dados/parâmetros solicitados, a API efetuará o processamento necessário e, se for o caso, dará o retorno daquele processamento.
outro exemplo: consultar um CEP
https://viacep.com.br/ws/01001000/json/
ele vai consultar a base de CEP do site viacep.com.br e retornar um JSON com as informações encontradas.
o link acima retorna um dado real (veja em https://viacep.com.br/). você pode trocar 01001000 pelo teu CEP e fazer o teste.
alguns WebServices NÃO apresentam o retorno imediato do processamento da API, então você terá que consumir uma API para efetuar a solicitação e depois uma outra API para obter o retorno daquela solicitação.
algumas APIs solicitam credenciais para que seja possível consumi-las; algumas solicitam usuário. senha, token, etc, outras requerem um certificado digital e ainda há aquelas - exemplo:ViaCEP - que não necessitam de credenciais.
as linguagens de programação possuem os recursos necessários para criar APIs e também para consumí-las (o termo utilizado quando se utiliza uma API é 'consumir'). você terá as funções/métodos para criar o XML/JSON ou até mesmo montar a URI necessária, bem como fazer a leitura do retorno, seja ele um XML ou um JSON.
muito obrigado, entendi melhor agora !!!
Responder
Gostei + 0
Clique aqui para fazer login e interagir na Comunidade :)