# API da loja de vales-presente da Bidali

> Uma API JSON gratuita e somente leitura para o catálogo de vales-presente deste site: países, categorias, moedas e marcas, com valores, instruções de resgate e termos. Sem cadastro e sem chave de API.

## Suas primeiras requisições

Cada endpoint é uma requisição GET que retorna JSON. Copie um comando e execute.

Liste os países com vales-presente

```sh
curl -s https://giftcards.bidali.com/api/v1/countries
```

Encontre vales-presente de supermercado no Canadá

```sh
curl -s "https://giftcards.bidali.com/api/v1/countries/canada/brands?category=groceries&limit=5"
```

Consulte uma marca: valores, resgate e termos

```sh
curl -s https://giftcards.bidali.com/api/v1/countries/canada/brands/doordash-ca
```

Leia qualquer página em Markdown

```sh
curl -s -H "Accept: text/markdown" https://giftcards.bidali.com/brands/canada/doordash-ca
```

## Endpoints

- `GET /api/v1`: Describe the Catalogue API
- `GET /api/v1/countries`: List the countries with gift cards
- `GET /api/v1/categories`: List the gift card categories
- `GET /api/v1/currencies`: List the currencies gift cards are priced in
- `GET /api/v1/countries/{country}/brands`: List the brands on sale in a country
- `GET /api/v1/countries/{country}/brands/{brand}`: Get one brand: amounts, redemption and terms
- `GET /api/v1/openapi.json`: Get this OpenAPI document as JSON
- `GET /api/v1/openapi.yaml`: Get this OpenAPI document as YAML

## Tudo o que um agente pode ler

- OpenAPI 3.1: https://giftcards.bidali.com/openapi.json · https://giftcards.bidali.com/openapi.yaml
- Markdown: `Accept: text/markdown`, or https://giftcards.bidali.com/index.md
- llms.txt: https://giftcards.bidali.com/llms.txt
- Sitemap: https://giftcards.bidali.com/sitemap.xml

## Erros

Os erros são JSON, com o status HTTP adequado: 400 para um parâmetro ausente ou inválido, 404 para país, marca ou caminho desconhecido, 405 para qualquer método que não seja GET, e 502 ou 504 quando o serviço do catálogo falha. O campo code não muda; o campo hint diz o que fazer em seguida.

```json
{ "error": { "code": "country_not_found", "message": "No country matches \"atlantis\".", "hint": "Use a slug or an ISO 3166-1 alpha-2 code from GET /api/v1/countries.", "docs": "https://giftcards.bidali.com/developers#errors" } }
```

As respostas ficam em cache por até cinco minutos. Uma página traz no máximo 100 marcas: siga pagination.next para ver o restante.

## Compre vales-presente com a Gift Card API da Bidali

Esta API só lê o catálogo. Para comprar vales-presente a partir do seu próprio software ou de um agente de IA, use a Gift Card API da Bidali. Ela funciona com chaves de API e está em acesso antecipado.

- Ler a documentação: https://docs.bidali.com
- Gift Card API: https://www.bidali.com/products/gift-card-api
- Falar com vendas: https://www.bidali.com/contact?intent=sales

O acesso por MCP chegará em breve.

## Other formats

- HTML page: https://giftcards.bidali.com/pt/developers
- This page as Markdown: https://giftcards.bidali.com/pt/developers.md
- Same data as JSON (Catalogue API): https://giftcards.bidali.com/api/v1
- Guide to this store for AI agents: https://giftcards.bidali.com/llms.txt
- Catalogue API reference (OpenAPI 3.1): https://giftcards.bidali.com/openapi.json

## Languages

[English](https://giftcards.bidali.com/developers.md) · [Español](https://giftcards.bidali.com/es/developers.md) · [Português](https://giftcards.bidali.com/pt/developers.md) · [Français](https://giftcards.bidali.com/fr/developers.md) · [Deutsch](https://giftcards.bidali.com/de/developers.md) · [Italiano](https://giftcards.bidali.com/it/developers.md) · [Polski](https://giftcards.bidali.com/pl/developers.md) · [Svenska](https://giftcards.bidali.com/sv/developers.md)