> ## Documentation Index
> Fetch the complete documentation index at: https://docs.aftersell.com/llms.txt
> Use this file to discover all available pages before exploring further.

# O que é uma API?

> A Application Programming Interface (interface de programação de aplicações) funciona como um intermediário que permite que diferentes aplicações de software interajam e troquem dados.

<div id="a-simple-analogy-a-restaurant-a-waiter">
  # Uma analogia simples: um restaurante e um garçom
</div>

Imagine que você está jantando em um restaurante.

1. **Você, o cliente**, consulta o cardápio e faz um pedido de cheeseburger com batatas fritas (parecido com fazer uma solicitação de dados do carrinho).
2. **O garçom (API)** anota seu pedido e o comunica à cozinha (assim como uma API recebe sua solicitação e a envia a um servidor).
3. **A cozinha (servidor)** prepara sua refeição, processando o pedido e reunindo os ingredientes necessários (de forma parecida com como um servidor recupera ou manipula os dados do carrinho).
4. **O garçom (API)** então entrega a refeição na sua mesa, permitindo que você aproveite sua comida (assim como uma API retorna os dados solicitados e atualiza seu carrinho).

Essa analogia oferece uma forma simples de entender como as APIs funcionam, especialmente se você é novo nesse assunto. Ao usar a API do Upcart, pense nela como fazer um pedido em um restaurante — decida o que você quer que o carrinho faça e deixe a API cuidar do resto.

Descubra como a API do Upcart pode elevar sua loja explorando nossa [documentação da API](/pt/upcart/introduction_to_upcarts_public_api).

***

<div id="how-this-relates-to-upcarts-api">
  # Como isso se relaciona com a API do Upcart
</div>

A API pública do Upcart oferece flexibilidade para personalizar e gerenciar a funcionalidade do seu carrinho, de forma parecida com dar instruções específicas a um garçom.

Por exemplo, se você quiser testar se a API do Upcart está funcionando corretamente, pode executar um script simples dentro do seu HTML personalizado que registra uma mensagem sempre que o carrinho for aberto:

```
<script>  
  window.upcartSubscribeCartOpened(() => {  
    console.log("UpCart API Test - The cart has been opened!");  
  });  
</script>
```

<div id="verifying-if-its-working">
  ## Verificando se está funcionando
</div>

1. Abra sua loja e navegue até **Upcart Settings → Custom HTML** para adicionar o script.
2. Salve suas alterações e atualize sua loja.
3. Abra o console do navegador (**F12** ou **Ctrl + Shift + J** no Windows, ou **Cmd + Option + J** no Mac).
4. Abra o carrinho do Upcart e você verá a mensagem de confirmação aparecer no console:

```
Upcart API Test - The cart has been opened!
```

<img src="https://mintcdn.com/aftersell/uxKAdY-e0h16xa48/images/upcart/api-custom-html-test-script.png?fit=max&auto=format&n=uxKAdY-e0h16xa48&q=85&s=5df59c4ceee2ee520c39b5dd861c46ec" alt="Script de teste no Custom HTML do Upcart registrando uma mensagem de carrinho aberto no console do navegador" width="1472" height="1086" data-path="images/upcart/api-custom-html-test-script.png" />

***

<div id="want-to-learn-more-about-apis">
  ## Quer aprender mais sobre APIs?
</div>

Se você tem interesse em se aprofundar em APIs e JavaScript, aqui estão alguns recursos para iniciantes que podem ajudar você a começar.

**Aprendizado de API e JavaScript para iniciantes:**

* [W3Schools: JavaScript Basics](https://www.w3schools.com/js/) – aprenda scripts básicos para usar a API do Upcart
* [MDN Web Docs: APIs for Beginners](https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Client-side_web_APIs) – entenda como as APIs funcionam em lojas online
* Shopify Developer Docs – [Shopify AJAX API](https://shopify.dev/docs/api/ajax) (útil para lojistas que integram o Upcart com o carrinho da Shopify)

A API do Upcart funciona perfeitamente sem a necessidade de ferramentas externas como o Postman — você pode usá-la diretamente nas configurações de Custom HTML do Upcart ou no código do seu tema da Shopify.

***

<div id="need-assistance">
  ## Precisa de ajuda?
</div>

Se você é novo em APIs, sem problemas! Você não precisa escrever JavaScript do zero — basta copiar e colar scripts prontos nas configurações de Custom HTML do Upcart para personalizar seu carrinho em minutos.

Não sabe por onde começar? Entre em contato com um [Shopify Expert](https://www.shopify.com/partners/directory) ou explore nossa [documentação da API](/pt/upcart/introduction_to_upcarts_public_api).

***