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

# Sobre a API

> Sincronize os cadastros de Produtos, Parceiros, Pagamentos e Configurações de uma Retaguarda com o sistema integrador.

## Visão Geral

A API de Integração BSAPI tem como objetivo realizar a integraçã do ERP Nuvem com sistemas que desejem fazer a centralização de dados de vendas, e até mesmo a sincronziaçao de produtos/estoque entre os sistemas.

## JSON

A comunicação com a API é realziada com payloads em JSON, o padrão para API's REST. Cada requisição que necessite de um BODY tem um contrato para a transferência de dados especificados em suas respectivas páginas no sistema. Recomenda-se especificar o tipo de dados nos cabeçalhos da requisição com` Content-Type: application/json`

## Autênticação nas Requisições

Para que seja possivel realizar as requisições á API com sucesso, é necessário que seja enviado uma **Chave de API** nos cabeçalhos da requisição especificado como um cabeçalho `x-api-key` . Apenas para consultar o status da API não é necessária a Autênticação.