O que significa API?

Uma API, abreviação de Application Programming Interface, significa um conjunto de códigos de funções que permitem que os aplicativos acessem dados especificados e interajam com componentes de aplicativos de software externos, sistemas operacionais ou microsserviços.

Para simplificar, uma API entrega uma resposta do usuário a um sistema e envia a resposta do sistema de volta ao usuário. Você clica em “adicionar ao carrinho”; uma API informa ao site que você adicionou um produto ao carrinho; o site coloca o produto no seu carrinho e seu carrinho é atualizado.

Você pode ouvir o termo “microsserviços” surgir em relação à API. Estes, no entanto, não são os mesmos. Microsserviços são um estilo ou arquitetura que divide a funcionalidade de uma aplicação web. Enquanto API é a estrutura com a qual os desenvolvedores interagem com um aplicativo da web. Os microsserviços podem realmente usar API para se comunicar entre si.

A API permite que um desenvolvedor faça uma “chamada” ou “solicitação” específica para enviar ou receber informações. Essa comunicação é feita por meio de uma linguagem de programação chamada “JSON”. Também pode ser usado para realizar uma ação definida, como atualizar ou excluir dados. Existem quatro métodos básicos de solicitação que podem ser feitos com API:

GET – Reúne informações (extrai todos os códigos de cupom)

PUT – Atualiza dados (atualizando preços do produto)

POST – Cria (Criando uma nova categoria de produto)

DELETE – (Excluindo uma postagem do blog)

O que é JSON e por que é usado?

JSON (JavaScript Object Notation) é usado para representar dados em um servidor. É bastante fácil de ler por humanos e fácil de entender para máquinas/aplicativos. Vejamos um exemplo de JSON de um produto no BigCommerce:

Isso é fácil de entender, pois é gerado em pares chave/valor, com a chave à esquerda e um valor à direita. As chaves são um objeto fixo definido pelo aplicativo e permanecerão as mesmas da “categoria”. Já os valores serão únicos, como “Camisas”.

O que é uma solicitação de API?

Existem vários componentes de uma solicitação de API para que ela funcione. Vamos examiná-los individualmente e como eles podem ser usados ​​para criar uma solicitação.

O que é Endpoint?

Existem duas partes principais em um endpoint que são usadas ao fazer uma solicitação de API. Um deles é o URL. BigCommerce usa https://api.bigcommerce.com/stores/ como URL para todas as solicitações de API. Pode parecer um URL normal, mas se você conectá-lo a um navegador da web, receberá uma mensagem de erro 404.

A segunda parte é o caminho. O caminho irá variar dependendo do que você está tentando realizar. Você pode encontrar uma lista de caminhos disponíveis para BigCommerce visitando nossa documentação do desenvolvedor: https://developer.bigcommerce.com/api-reference. Para este exemplo, usaremos o caminho do produto que é /v3/catalog/products.

Quando juntamos essas duas partes, obtemos um endpoint completo https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products. Agora você pode estar se perguntando “O que é {store_hash}?” “De onde veio isso?” Isso é conhecido como variável. Variáveis ​​são componentes exclusivos de um endpoint e variam dependendo das informações da sua loja. Você pode identificar uma variável pelos colchetes abertos e fechados “{}”.

O que é cabeçalho?

Os cabeçalhos fornecem informações ao cliente e ao servidor. Exemplos comuns de cabeçalho seriam credenciais de autenticação, como “Token de autenticação” ou “ID do cliente”. Essas credenciais são fornecidas automaticamente quando você cria uma conta API. Outro cabeçalho comum é conhecido como “Tipo de Conteúdo”, que informa ao servidor sobre que tipo de conteúdo será enviado. Por exemplo, um tipo de conteúdo comumente usado é “application/json”, que informa ao servidor que estamos enviando dados JSON.

O que é Método?

Métodos são as ações executadas ao enviar uma solicitação. Pense no início, quando discutimos GET, PUT, POST e DELETE. Todos esses são métodos API.

O que são dados?

Os dados da solicitação, também comumente chamados de “corpo”, são informações que serão enviadas ou retornadas por um servidor. Na discussão anterior sobre JSON, você pode ver um exemplo de dados de API. O corpo de uma solicitação às vezes exigirá informações específicas antes de ser entregue. Um exemplo disso é que se você estiver editando um único produto, o ID do produto será necessário antes que qualquer alteração possa ser feita.

Saiba mais SUA PARTICIPAÇÃO FAZ A DIFERENÇA.