---
title: "Boas práticas"
description: "Boas práticas para integração de APIs robusta e eficiente"
url: "https://api-portal-suitelogi-ppr.stef.com/pt/guides/best-practices"
image: "https://api-portal-suitelogi-ppr.stef.com/_og/d/c_Ocean.takumi,title_~Qm9hcyBwcsOhdGljYXM,description_~Qm9hcyBwcsOhdGljYXMgcGFyYSBpbnRlZ3Jhw6fDo28gZGUgQVBJcyByb2J1c3RhIGUgZWZpY2llbnRl,props_eyJ0aGVtZSI6eyJtb2RlIjoibGlnaHQiLCJjb2xvcnMiOnsicHJpbWFyeSI6IiM1NTk2ZTYifX19,p_Ii9wdC9ndWlkZXMvYmVzdC1wcmFjdGljZXMi,s_douHKmEa-mmjbezL.png"
---

**Portal do Desenvolvedor**

-   [APIs](https://api-portal-suitelogi-ppr.stef.com/pt/apis)
-   [Começar](https://api-portal-suitelogi-ppr.stef.com/pt/getting-started)
-   [Guias](https://api-portal-suitelogi-ppr.stef.com/pt/guides)
-   [Suporte](https://api-portal-suitelogi-ppr.stef.com/pt/support)

[FR](https://api-portal-suitelogi-ppr.stef.com/)|[EN](https://api-portal-suitelogi-ppr.stef.com/en)|[ES](https://api-portal-suitelogi-ppr.stef.com/es)|[IT](https://api-portal-suitelogi-ppr.stef.com/it)|**[PT](https://api-portal-suitelogi-ppr.stef.com/pt)**|[NL](https://api-portal-suitelogi-ppr.stef.com/nl)|[DE](https://api-portal-suitelogi-ppr.stef.com/de)

## Boas práticas

Padrões recomendados para construir integrações robustas e eficientes com as APIs STEF.

## [Limitação de taxa](#limitação-de-taxa)

Respeite os cabeçalhos de limitação de taxa devolvidos pela API:

| Cabeçalho             | Descrição                              |
| :-------------------- | :------------------------------------- |
| X-RateLimit-Limit     | Número máximo de pedidos por janela    |
| X-RateLimit-Remaining | Pedidos restantes na janela atual      |
| X-RateLimit-Reset     | Timestamp de reinicialização da janela |
| Retry-After           | Segundos a aguardar (em caso de 429)   |

## [Segurança](#segurança)

### [Armazenamento de segredos](#armazenamento-de-segredos)

Nunca armazene o seu Client Secret ou API Key diretamente no código fonte.

Utilize variáveis de ambiente ou um gestor de segredos:

```bash
# .env
STEF_CLIENT_ID=your_client_id
STEF_CLIENT_SECRET=your_client_secret
```

```bash
# .gitignore
.env
```

## [Desempenho](#desempenho)

### [Cache](#cache)

-   Guarde em cache as respostas dos endpoints de leitura que não mudam frequentemente
-   Respeite os cabeçalhos `Cache-Control` e `ETag`
-   Utilize pedidos condicionais (`If-None-Match`, `If-Modified-Since`)

### [Paginação eficiente](#paginação-eficiente)

-   Utilize a paginação por cursor fornecida pela API
-   Limite o número de elementos por página (`limit`) ao estritamente necessário
-   Evite carregar todas as páginas de uma só vez

### [Compressão](#compressão)

Ative a compressão gzip nos seus pedidos:

```bash
curl -X GET "https://api.stef.com/v1/transport/orders" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Accept-Encoding: gzip"
```

## [Monitorização](#monitorização)

-   Registe os tempos de resposta e os códigos de retorno
-   Configure alertas para erros 4xx e 5xx
-   Monitorize o seu consumo de quotas através do painel do portal

#### [APIs](#apis)

-   [Catálogo de APIs](https://api-portal-suitelogi-ppr.stef.com/pt/apis)
-   [Guia de início](https://api-portal-suitelogi-ppr.stef.com/pt/getting-started)

#### [Desenvolvedores](#desenvolvedores)

-   [Documentação](https://api-portal-suitelogi-ppr.stef.com/pt/guides)
-   [Boas práticas](https://api-portal-suitelogi-ppr.stef.com/pt/guides/best-practices)
-   [Portais](https://api-portal-suitelogi-ppr.stef.com/pt/getting-started/instances)

#### [Suporte](#suporte)

-   [Suporte técnico](https://api-portal-suitelogi-ppr.stef.com/pt/support)

#### [Idiomas](#idiomas)

-   [Français](https://api-portal-suitelogi-ppr.stef.com/)
-   [English](https://api-portal-suitelogi-ppr.stef.com/en)
-   [Español](https://api-portal-suitelogi-ppr.stef.com/es)
-   [Italiano](https://api-portal-suitelogi-ppr.stef.com/it)
-   [Português](https://api-portal-suitelogi-ppr.stef.com/pt)
-   [Nederlands](https://api-portal-suitelogi-ppr.stef.com/nl)
-   [Deutsch](https://api-portal-suitelogi-ppr.stef.com/de)

© 2026 STEF — Todos os direitos reservados

[Mentions légales](https://www.stef.com/mentions-legales) · [Politique de confidentialité](https://www.stef.com/politique-confidentialite)