Introdução

Esta página irá ajudá-lo a começar a utilizar a API Get Commerce

A documentação é dividida entre categorias. Onde, cada categoria listada, refere-se a um tipo de entidade dentro da Get Commerce.

Cada entidade possui a documentação sobre seus respectivos métodos (GET, POST, PUT, DELETE), explicando como tirar melhor proveito de cada um dos mesmos.

📘

Nem todas as entidade possuem todos os métodos disponíveis

Autenticação

A autenticação necessária para utilizar a API segue o modelo Bearer Authentication, onde um header de autorização contendo um token, que poderá ser gerado no painel Get Commerce, é enviado junto às requisições.

Exemplo de requisição com o header de autorização

Exemplo de requisição com o header de autorização

Endpoints

Todas as requisições seguem o mesmo padrão de endpoint, onde a entidade (ENTITY) é precedida do domínio completo da loja acrescentado de /api. 

https://your-domain.com/api/{ENTITY}

Métodos GET e DELETE

Para estes métodos, são disponibilizados atributos para serem utilizados na filtragem de resultados que serão retornados/deletados. Os filtros disponíveis para cada requisição estarão listados na seção QUERY PARAMS da mesma.

Seção **QUERY PARAMS** da requisição [Listar Clientes](/reference/listar-clientes)

Seção QUERY PARAMS da requisição Listar Clientes

Métodos PUT e POST

Para estes métodos, os parâmetros do body da requisição serão utilizados para definir os atributos de novos registros (POST) ou a atualização de atributos de registros já existentes (PUT). Os parâmetros disponíveis para cada requisição estarão listados na aba BODY PARAMS da mesma.

Seção **BODY PARAMS** da requisição [Criar Cliente](/reference/criar-cliente)

Seção BODY PARAMS da requisição Criar Cliente

📘

Em métodos PUT sempre deverá haver um atributo identificador da entidade a ser atualizada. Para produtos, por exemplo, o atributo é o sku