> For the complete documentation index, see [llms.txt](https://apidoc.toplojas.com.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://apidoc.toplojas.com.br/funcionamento/utilizando-o-simulador-online.md).

# Utilizando o Simulador Online

Através de nosso simulador você pode **testar todos os métodos**:

{% embed url="<https://api.toplojas.com.br/doc/>" %}

## Configurando o Token e o Identificador da Loja

Antes de começar a utilizar, clique em "**Authorize**":

Preencha seu "**Token**" e o "**Identificador da Loja**" conforme os dados obtidos em:

{% content-ref url="/pages/-MObk4z78qnd5Uc2I2C4" %}
[Geração de Token](/funcionamento/geracao-de-token.md)
{% endcontent-ref %}

### Exemplo:

![](/files/-MOi59tEh0Pw0uJnVP1m)

Após, clique nos **DOIS** botões de "**Authorize**":

![](/files/-MOi5CEcxI_s8N7tKm69)

Após isto, o botão <img src="/files/-MOhvGeUwLlMnVApf21e" alt="" data-size="line"> irá sumir e será exibido o botão <img src="/files/-MOhvL0BmX8Crul-61Ck" alt="" data-size="line"> , exemplo:

![](/files/-MOhvMx09_HxqSBA5h3c)

Pronto! Feche a janela através do "**X**" no canto direito superior e comece a testar a API.

## Chamando o endpoint "/status/"

Para testarmos o funcionamento, iremos acionar o endpoint "*/status/*", para isto, localize a seção "**Outros -> Status**" e clique na linha azul:

![](/files/-MOhvwwf-jwZ6fLX62ES)

Após isto, o sistema irá exibir quais os parâmetros que podem ser enviados, o que pode (ou deve) ser enviado no body da requisição e qual o retorno esperado.

![](/files/-MOhwPI6Fc0W06h_KvmM)

Clique em "**Try it Out**" e após em "**Execute**":

![](/files/-MOhwO2qGxKtEGSCk7m3)

Após isto, será exibido alguns detalhes muito importantes:

* A requisição CURL completa
* A url completa chamada
* A resposta do servidor

### Exemplo:

![](/files/-MOhwzpEE7lrjyeeB9k9)

Observe também, que existe uma área "**Responses**", onde o sistema mostra cada campo que pode ser retornado e exemplos de retorno.

![](/files/-MOhxBynI5c14app9CCd)

## Quais dados devem ser enviados

Ao abrir um dos métodos, o sistema exibe um exemplo dos campos que devem ser enviados no body da requisição.

![](/files/-MOi5qK96My5YgfBq8lp)

Em alguns métodos, existem mais exemplos para o mesmo método, para isto, clique no campo ao lado de "**Examples**":

![](/files/-MOi62899EKbcaBZOtK1)

Junto ao exemplo de dados, temos a referência de cada campo que pode ser enviado e seus requisitos, para isto, clique em "**Schema**":

![](/files/-MOi6LmxYPwx04Y6e6k6)

Neste espaço é exibido todos os campos, exemplo de como devem ser preenchidos, quais são obrigatórios e os tipos de informações esperados.

## Quais dados devem ser recebidos

Ao abrir um dos métodos, no espaço "**Responses**", o sistema exibe um exemplo dos dados que são retornados:

![](/files/-MOi6rU_ZBSL_U34GJ5i)

Em alguns métodos, existem mais exemplos para o mesmo método, para isto, clique no campo ao lado de "**Examples**":

![](/files/-MOi6xdkjQQX5A-tvltx)

Junto ao exemplo de dados, temos a referência de cada campo que pode ser retornado e seus requisitos, para isto, clique em "**Schema**":

![](/files/-MOi74V4jhCYhc0pTSE8)

Neste espaço é exibido todos os campos que podem ser retornados, os valores possíveis e os tipos de dados que serão retornados.
