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

# Introdução

![PontoDigital Banner](https://s3.tebi.io/ponto-digital/images/seo-banner.png)

***

### Primeiros Passos

Existem dois ambientes de integração: **Staging** e **Production**. Cada um possui características específicas:

#### Staging

Este ambiente é destinado ao desenvolvimento. Ele fornece dados predefinidos, como administradores, funcionários e jornadas, para facilitar a sua integração. Claro, você também pode criar seus próprios dados conforme necessário.

#### Production

Este é o ambiente real, onde seus funcionários poderão se conectar e utilizar o sistema com todas as funcionalidades. Após concluir o desenvolvimento, basta trocar o endpoint e a chave de API para que a sua integração funcione corretamente.

### Ambientes

Abaixo você vai encontrar informações importantes sobre cada um dos ambientes:

#### Endpoints

| Ambiente   | URI                                        |
| ---------- | ------------------------------------------ |
| Staging    | <https://staging-api.pontodigital.me/api/> |
| Production | <https://api.pontodigital.me/api/>         |

#### Limites de Funcionários e Jornadas

**Staging**

| Recurso      | Quantidade |
| ------------ | ---------- |
| Funcionários | 5          |
| Jornadas     | 5          |

**Production**

| Recurso      | Quantidade                     |
| ------------ | ------------------------------ |
| Funcionários | Definido pelo plano contratado |
| Jornadas     | Definido pelo plano contratado |

### Exemplo de Uso

Este é um exemplo de como se conectar com a API através da biblioteca axios do NodeJS.

```typescript
import axios from "axios";

const pontoDigitalApi = axios.config({
  baseURL: process.env.PONTO_DIGITAL_API_URL,
  headers: {
    "x-api-key": process.env.PONTO_DIGITAL_API_KEY,
  },
});

pontoDigitalApi.get("/v1/workers")
  .then((response) => {
    console.log(response.data)
  })
  .catch((error) => {
    console.error(handlePontoDigitalError(error));
  });
```

```bash
PONTO_DIGITAL_API_URL="https://staging-api.pontodigital.me/api"
PONTO_DIGITAL_API_KEY="PD_KEY_FK321A1C...7XLYS4CB"
```

***

Em caso de problemas ou dúvidas, entre em contato com <suporte@pontodigital.me>.