> For the complete documentation index, see [llms.txt](https://docs.getcommerce.com.br/central-de-ajuda/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.getcommerce.com.br/central-de-ajuda/integracoes/api.md).

# API

Bem-vindo ao guia da **API Get Commerce**! Este guia foi criado para ajudar você a entender o que é uma API e como disponilizá-la à sua equipe técnica para que estes possam utilizar os recursos da mesma.

## **📍** O que é uma API?

API significa **Interface de Programação de Aplicativos**. É uma maneira para diferentes sistemas se comunicarem entre si. Simplificando, é como um conjunto de regras que permite que um aplicativo ou sistema solicite e receba informações de outro.

Nossa API permite que sistemas externos acessem e utilizem recursos da sua loja **Get Commerce** de forma programática e segura. Alguns recursos disponíveis:&#x20;

**- Busca de pedidos;**\
**- Criação de produtos.**&#x20;

## **📍 Como gerar o Token da API**

Para que seu time técnico/sistema externo consiga acessar estes recursos, é necessário que um aplicativo de API seja criado em sua plataforma **Get Commerce**. \
\
Este aplicativo irá intermediar a conexão entre a **Get Commerce** e seu sistema, armazenando informações sobre a troca de dados entre os sistemas e o token que deverá ser utilizado pelo sistema para autorizar estas trocas. \
\
Mas calma, o processo é bem simples! Para criar um novo aplicativo e gerar seu token, basta seguir o passo a passo abaixo  :smile:

{% tabs %}
{% tab title="Passo 1" %}
Com sua plataforma **Get Commerce** aberta, navegue até a aba **Configurações > Api > Meus Apps.** Nesta aba serão listados todos os Apps de Api cadastrados em sua loja:&#x20;

<figure><img src="https://2206415355-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fc5NHXi3gnF78PHsX87v1%2Fuploads%2FAjBCuhA1vkK9VIslcLor%2Fimage.png?alt=media&amp;token=433802b7-5be3-4349-b517-3ccb11520bdc" alt=""><figcaption><p>Lista de Apps de API cadastrados na plataforma</p></figcaption></figure>

Para criar um novo, basta clicar em: <img src="https://2206415355-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fc5NHXi3gnF78PHsX87v1%2Fuploads%2FOQYVHw3LNJ6pI3WJrreP%2Fimage.png?alt=media&amp;token=7667c729-2dcb-419f-a994-682c3fe4883e" alt="" data-size="line">
{% endtab %}

{% tab title="Passo 2" %}
Na tela de cadastro de um novo app, preencha os campos conforme desejar e clique em: <img src="https://2206415355-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fc5NHXi3gnF78PHsX87v1%2Fuploads%2FSenfBDkxzciBweFum1OO%2Fimage.png?alt=media&amp;token=40a56397-c90c-4362-ac74-3e052fea4fb8" alt="" data-size="line">

<figure><img src="https://2206415355-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fc5NHXi3gnF78PHsX87v1%2Fuploads%2FiBfTKpsnCikFZpHf75mA%2Fimage.png?alt=media&amp;token=1f4b51db-b5e2-4957-80f3-3529f018c662" alt=""><figcaption><p>Tela "Novo App"</p></figcaption></figure>
{% endtab %}

{% tab title="Passo 3" %}
Feito isso, seu novo app será criado e o **token** da API já estará disponível na aba **Autenticação** do mesmo!

<figure><img src="https://2206415355-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fc5NHXi3gnF78PHsX87v1%2Fuploads%2F5lcB2ggffQNuviB54Kvm%2Fimage.png?alt=media&amp;token=a63dbbe7-ee9b-4307-bbe1-d0210569098c" alt=""><figcaption><p>Tela "Autenticação" do App</p></figcaption></figure>
{% endtab %}
{% endtabs %}

Com o **token** em mãos, o sistema externo já poderá utilizar os recursos da API!

{% hint style="info" %}
**Documentação técnica da API**

Para acessar a documentação técnica da API, acesse o link: <https://getcommerce.readme.io/>
{% endhint %}
