🔗APIs e JSON

Sobre APIs e a utilização dos arquivos de extensão JSON no Ábaris

Visão geral

A extensão de arquivos JSON (Notação de Objeto do JavaScript) é um formato leve e amplamente utilizado para armazenar e transmitir dados, especialmente em aplicações que utilizam APIs (Application Programming Interfaces). Essa linguagem é baseada em texto e fácil de ler tanto para humanos quanto para máquinas.

No contexto das APIs do Ábaris, o JSON é usado para Estruturar Dados, organizando as informações em pares chave-valor. Por exemplo:

{
  "nome": "João",
  "idade": 25,
  "endereco": {
    "cidade": "São Paulo",
    "estado": "SP"
  }
}

Nesse exemplo:

• "nome", "idade", e "endereco" são chaves.

• "João", 25, e o objeto dentro de "endereco" são valores.

Outro uso do JSON nas APIs do Ábaris é Trocar de Dados, dependendo do método da sua integração. Ou seja, uma pessoa pode enviar uma solicitação JSON e receber uma resposta JSON.

Por exemplo: um usuário abre uma solicitação (Request) para a criação do usuário através de um código e recebe um retorno (Response) também através de um JSON.

APIs REST

As APIs padrão REST funcionam por meio de uma indicação de um caminho/URL e utilizamos alguns métodos para manipular esses dados. O método pode ser GET (que pede informações), POST (que envia novos dados), PUT (que atualiza dados existentes) e o DELETE (que, como o nome já diz, remove os dados desde endereço/banco de dados ou planilha de informações).

APIs SOAP

As APIs SOAP (Simple Object Access Protocol) são um protocolo padrão baseado em XML que permite a comunicação entre sistemas diferentes através da troca de mensagens. Elas são usadas principalmente em momentos ou ambientes de troca de dados onde a robustez, segurança e padronização são fundamentais.

O SOAP é independente de plataforma e linguagem, mas exige que todas as mensagens sejam enviadas no formato XML e sigam regras rígidas de estrutura.

No Ábaris

No Ábaris o usuário final não vê as linhas de código na tela e, na maioria das vezes, sequer sabe da existência desses métodos. É aqui o momento no qual o Ábaris interpreta o código, que precisa estar redondo/sem erros para realizar essa tradução sem dar erro. Por isso, neste manual, indicaremos boas práticas para a manipulação das suas APIs.