---
title: "API V1"
slug: "api-v1"
updated: 2024-04-26T13:04:10Z
published: 2024-04-26T13:04:10Z
canonical: "help.hiplatform.com/api-v1"
---

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

# API V1

A API V1 da Yourviews é a versão mais completa e fácil de utilizar. Toda a documentação é feita utilizando o modelo Postman.

Para acessar a documentação, utilize o link abaixo: [https://www.postman.com/yourviews/workspace/yourviews-s-public-workspace/documentation/17462514-7b87129a-bd40-4894-a4df-17c765012880](https://www.postman.com/yourviews/workspace/yourviews-s-public-workspace/documentation/17462514-7b87129a-bd40-4894-a4df-17c765012880)

          Lembre-se

          

Temos outras versões de API que talvez sejam mais apropriadas para seu caso de uso. [Clique aqui](https://help.hiplatform.com/v1/docs/introducao-1) para ver mais informações dessas outras possibilidades.

## Autenticação

          IMPORTANTE

          

Essa API faz bloqueio de CORS, dessa forma, ela não deve ser chamda via Frontend diretamente. Para isso, utilize nossa [API V2](https://help.hiplatform.com/docs/api-v2)

Para fazer chamadas à API, você precisa de três informações: 1 - Código da Loja 2 - Usuário de API 3 - Senha de API

Você pode obter essas informações no painel administrativo da Yourviews, em Conta > Código da Loja. ![image.png](https://cdn.document360.io/fbdc20e9-fffd-4203-8df2-642bdec311ea/Images/Documentation/image%2889%29.png)

## Como utilizar a documentação no Postman?

### Introdução

Antes de mais nada, leia a [introdução](https://www.postman.com/yourviews/workspace/yourviews-s-public-workspace/documentation/17462514-7b87129a-bd40-4894-a4df-17c765012880) da documentação. Ela explica os princípios básicos de fazer uma chamada para nossa API, bem como explica como fazer a devida autenticação.

### Estruturas de dados

No início de cada tópico da documentação, é informada a Estrutura de Dados dessa respectiva seção. Por exemplo, ao clicar em "[Reviews de Produtos](https://www.postman.com/yourviews/workspace/yourviews-s-public-workspace/folder/17462514-b2282cd6-cf43-45a1-9c26-a74aceeb3120)", você pode visualizar a estrutura enviada e recebida pelas chamadas de API. Inclui uma breve explicação e o tipo do dado. ![image.png](https://cdn.document360.io/fbdc20e9-fffd-4203-8df2-642bdec311ea/Images/Documentation/image%2824%29.png)

### Exemplos

Cada chamada da API possui seu respectivo exemplo de chamada, que aparece ao lado direito da tela. ![image.png](https://cdn.document360.io/fbdc20e9-fffd-4203-8df2-642bdec311ea/Images/Documentation/image%2825%29.png)

Você pode alterar o formato de exemplo para a linguagem de programação que você usa, alterando a configuração no topo da documentação ![image.png](https://cdn.document360.io/fbdc20e9-fffd-4203-8df2-642bdec311ea/Images/Documentation/image%2826%29.png)

### Precisa de ajuda?

Se você precisar de ajuda extra ou necessitar de algum método extra em nossas APIs, por favor, entre em contato com [nosso suporte](https://www.hiplatform.com/suporte).