> 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:

![](https://1882612469-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MObfj7Rt58mdIJ_2Oby%2Fuploads%2Fgit-blob-cc5eaef8194e723f5d8e82c96411cbe99c393f9b%2F2020-12-16_20h37_25.png?alt=media)

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

![](https://1882612469-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MObfj7Rt58mdIJ_2Oby%2Fuploads%2Fgit-blob-e02332d40387494df0d0ac1647c1062e6bb77a4f%2F2020-12-16_20h39_00.png?alt=media)

Após isto, o botão <img src="https://1882612469-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MObfj7Rt58mdIJ_2Oby%2Fuploads%2Fgit-blob-c783af7c81c52611d19bb38f8e75dfdc43c3876e%2F2020-12-16_20h39_49.png?alt=media" alt="" data-size="line"> irá sumir e será exibido o botão <img src="https://1882612469-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MObfj7Rt58mdIJ_2Oby%2Fuploads%2Fgit-blob-5b4e7748099fea564324f870ea79ab6ad27a79de%2F2020-12-16_20h40_06.png?alt=media" alt="" data-size="line"> , exemplo:

![](https://1882612469-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MObfj7Rt58mdIJ_2Oby%2Fuploads%2Fgit-blob-da3a785044d25a939a4e89b7e90e771bfebaa510%2F2020-12-16_20h40_00.png?alt=media)

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:

![](https://1882612469-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MObfj7Rt58mdIJ_2Oby%2Fuploads%2Fgit-blob-84f802ec78a1e0c0b8c3ca921529ed16eece0764%2F2020-12-16_20h42_54.png?alt=media)

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.

![](https://1882612469-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MObfj7Rt58mdIJ_2Oby%2Fuploads%2Fgit-blob-9f275ee1fb9bf430b9604a13d26172cabb155f0b%2F2020-12-16_20h44_27.png?alt=media)

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

![](https://1882612469-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MObfj7Rt58mdIJ_2Oby%2Fuploads%2Fgit-blob-867551a8a24c5f5561a30c4d2d7349cd21323855%2F2020-12-16_20h44_50.png?alt=media)

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-x-prod.appspot.com/o/spaces%2F-MObfj7Rt58mdIJ_2Oby%2Fuploads%2Fgit-blob-d4287cd2be547fa489c706490c02bfff1ff7739d%2F2020-12-16_20h47_07.png?alt=media)

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-x-prod.appspot.com/o/spaces%2F-MObfj7Rt58mdIJ_2Oby%2Fuploads%2Fgit-blob-0aadcd5329b255b88edcdfe3f9f4196aee394272%2F2020-12-16_20h48_35.png?alt=media)

## 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-x-prod.appspot.com/o/spaces%2F-MObfj7Rt58mdIJ_2Oby%2Fuploads%2Fgit-blob-d33de09c89431c90736ac67b7a9b8bdcf6c354fb%2F2020-12-16_21h30_43.png?alt=media)

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-x-prod.appspot.com/o/spaces%2F-MObfj7Rt58mdIJ_2Oby%2Fuploads%2Fgit-blob-e8b2de3a4687577617a0feae832670a2bddc488c%2F2020-12-16_21h31_39.png?alt=media)

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-x-prod.appspot.com/o/spaces%2F-MObfj7Rt58mdIJ_2Oby%2Fuploads%2Fgit-blob-967c90e30a79e5b0ff2b885b704a5ad8f54073c4%2F2020-12-16_21h33_01.png?alt=media)

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-x-prod.appspot.com/o/spaces%2F-MObfj7Rt58mdIJ_2Oby%2Fuploads%2Fgit-blob-49950d52d8a950d642a99efaa6a4cec33084cb39%2F2020-12-16_21h35_20.png?alt=media)

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-x-prod.appspot.com/o/spaces%2F-MObfj7Rt58mdIJ_2Oby%2Fuploads%2Fgit-blob-e7ebf39a54efea803d558031c0ef7783b9ed9846%2F2020-12-16_21h35_42.png?alt=media)

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-x-prod.appspot.com/o/spaces%2F-MObfj7Rt58mdIJ_2Oby%2Fuploads%2Fgit-blob-3d7bd3ea3fc3180d967808b9d6d59e1e711205cf%2F2020-12-16_21h36_11.png?alt=media)

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