> For the complete documentation index, see [llms.txt](https://docs.celetus.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.celetus.com/quick-start.md).

# Quick Start

{% hint style="info" %}
**Fique por dentro:** A nossa API de integração irá permitir ter acesso aos dados de suas vendas, seus produtos entre outros.\
Essas informações poderão ser utilizadas para a integração a outros serviços.
{% endhint %}

## Segurança

Suas solicitações de API são autenticadas usando chaves de API. Qualquer solicitação que não inclua uma chave de API retornará um erro.

Você pode visualizar sua chave de API no seu painel a qualquer momento.

<figure><img src="/files/pna9jjkYUJvUjNjAO2Ob" alt=""><figcaption><p>Configuração de api de integração</p></figcaption></figure>

## Faça seu primeiro requisição

Para fazer sua primeira solicitação, envie uma requisição autenticada ao endpoint desejado. \
Lembre-se de incluir sua chave de acesso a API ao cabeçalho da requisição 'X-api-key'

## Recuperar Vendas.

<mark style="color:blue;">`GET`</mark> `https://api.celetus.com/api/sales`

{% tabs %}
{% tab title="200 Request successfully" %}

```javascript
{
  "id": "string",
  "totalCheckout": 0,
  "status": "string",
  "totalProducts": 0,
  "totalFrete": 0,
  "discount": 0,
  "createdAt": "2024-06-25T17:25:43.413Z",
  "updatedAt": "2024-06-25T17:25:43.413Z",
  "customer": {
    "id": "string",
    "name": "string",
    "document": "string",
    "email": "string",
    "phone": "string",
    "address": "string",
    "number": "string",
    "zipCode": "string",
    "complement": "string",
    "neighborhood": "string",
    "city": "string",
    "state": "string",
    "country": "string"
  },
  "products": [
    {
      "quantity": 0,
      "unitaryValue": 0,
      "name": "string",
      "id": "string",
      "productId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ]
}
```

{% endtab %}

{% tab title="404 Not Found" %}

```json
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "additionalProp1": "string",
  "additionalProp2": "string",
  "additionalProp3": "string"
}
```

{% endtab %}
{% endtabs %}

{% hint style="info" %}
**Fique por dentro:** Use  a documentação do [swagger](https://api.celetus.com/api/swagger/index.html) para testar sua api
{% endhint %}
