# Utilizando o Simulador Online

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

{% embed url="<http://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="geracao-de-token" %}
[geracao-de-token](https://apidoc.toplojas.com.br/funcionamento/geracao-de-token)
{% endcontent-ref %}

### Exemplo:

![](https://1882612469-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MObfj7Rt58mdIJ_2Oby%2F-MOi4Jcok77CsKYrWJah%2F-MOi59tEh0Pw0uJnVP1m%2F2020-12-16_20h37_25.png?alt=media\&token=8cda8394-bb81-43b3-bd29-2381c013e505)

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

![](https://1882612469-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MObfj7Rt58mdIJ_2Oby%2F-MOi4Jcok77CsKYrWJah%2F-MOi5CEcxI_s8N7tKm69%2F2020-12-16_20h39_00.png?alt=media\&token=5f67e559-a381-4589-aa7b-0dc10922b07f)

Após isto, o botão <img src="https://1882612469-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MObfj7Rt58mdIJ_2Oby%2F-MOhWzLTd1wMaPKHmosU%2F-MOhvGeUwLlMnVApf21e%2F2020-12-16_20h39_49.png?alt=media&#x26;token=3e12d4b6-c9e9-4a21-886e-564142eec6b0" alt="" data-size="line">  ira sumir e será exibido o botão <img src="https://1882612469-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MObfj7Rt58mdIJ_2Oby%2F-MOhWzLTd1wMaPKHmosU%2F-MOhvL0BmX8Crul-61Ck%2F2020-12-16_20h40_06.png?alt=media&#x26;token=d51cd3c5-4315-4d12-9803-b957ffc7e40a" alt="" data-size="line"> , exemplo:

![](https://1882612469-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MObfj7Rt58mdIJ_2Oby%2F-MOhWzLTd1wMaPKHmosU%2F-MOhvMx09_HxqSBA5h3c%2F2020-12-16_20h40_00.png?alt=media\&token=924d37ea-87a8-4c68-be76-19b9335fd2c6)

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, localizei a seção "**Outros -> Status**" e clique na linha azul:

![](https://1882612469-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MObfj7Rt58mdIJ_2Oby%2F-MOhWzLTd1wMaPKHmosU%2F-MOhvwwf-jwZ6fLX62ES%2F2020-12-16_20h42_54.png?alt=media\&token=90a0c2e1-9466-497c-9425-25a1fbb8cc30)

Após isto, o sistema ira 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.

![](https://1882612469-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MObfj7Rt58mdIJ_2Oby%2F-MOhWzLTd1wMaPKHmosU%2F-MOhwPI6Fc0W06h_KvmM%2F2020-12-16_20h44_27.png?alt=media\&token=a782b7c3-3332-4247-90d6-4254d64d5b2f)

Clique em "**Try in Out**" e após em "**Execute**":&#x20;

![](https://1882612469-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MObfj7Rt58mdIJ_2Oby%2F-MOhWzLTd1wMaPKHmosU%2F-MOhwO2qGxKtEGSCk7m3%2F2020-12-16_20h44_50.png?alt=media\&token=a6410eb5-ed7c-4ba4-92be-1ff8007eb028)

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

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

### Exemplo:

![](https://1882612469-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MObfj7Rt58mdIJ_2Oby%2F-MOhWzLTd1wMaPKHmosU%2F-MOhwzpEE7lrjyeeB9k9%2F2020-12-16_20h47_07.png?alt=media\&token=65d02165-b05b-4692-903c-3d2ec34aa98d)

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

![](https://1882612469-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MObfj7Rt58mdIJ_2Oby%2F-MOhWzLTd1wMaPKHmosU%2F-MOhxBynI5c14app9CCd%2F2020-12-16_20h48_35.png?alt=media\&token=8398256e-1ca7-413b-b6b4-182c12659934)

## 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.

![](https://1882612469-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MObfj7Rt58mdIJ_2Oby%2F-MOi5SEXikbdy8Z11JZc%2F-MOi5qK96My5YgfBq8lp%2F2020-12-16_21h30_43.png?alt=media\&token=168a03b0-05b0-4303-9616-24342c65322a)

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

![](https://1882612469-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MObfj7Rt58mdIJ_2Oby%2F-MOi5SEXikbdy8Z11JZc%2F-MOi62899EKbcaBZOtK1%2F2020-12-16_21h31_39.png?alt=media\&token=50aef1ea-e1e8-44e5-95b5-688cf6d4e89d)

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

![](https://1882612469-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MObfj7Rt58mdIJ_2Oby%2F-MOi5SEXikbdy8Z11JZc%2F-MOi6LmxYPwx04Y6e6k6%2F2020-12-16_21h33_01.png?alt=media\&token=bffffb77-d501-4a6c-936b-f5964001dae9)

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:

![](https://1882612469-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MObfj7Rt58mdIJ_2Oby%2F-MOi5SEXikbdy8Z11JZc%2F-MOi6rU_ZBSL_U34GJ5i%2F2020-12-16_21h35_20.png?alt=media\&token=9279813e-ed5f-42ab-b5e8-f8a1e3819827)

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

![](https://1882612469-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MObfj7Rt58mdIJ_2Oby%2F-MOi5SEXikbdy8Z11JZc%2F-MOi6xdkjQQX5A-tvltx%2F2020-12-16_21h35_42.png?alt=media\&token=2ba2a198-0cf7-4497-b844-8ee4723a53af)

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

![](https://1882612469-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MObfj7Rt58mdIJ_2Oby%2F-MOi5SEXikbdy8Z11JZc%2F-MOi74V4jhCYhc0pTSE8%2F2020-12-16_21h36_11.png?alt=media\&token=a71ee371-c2d1-4583-9f68-424ae39b4ae6)

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