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

# Introdução

> A API de taxas de câmbio da Cleariflow oferece conversão de moeda em tempo real através de uma interface RESTful JSON moderna — com suporte para mais de 80 moedas globais, taxas ao vivo e conversão instantânea.

## Primeiros passos

<Card title="Taxas de câmbio ao vivo" icon="activity" href="exchange-rates/live">
  O endpoint `live` fornece acesso instantâneo às taxas de câmbio atuais em várias moedas, permitindo cálculos financeiros em tempo real e monitorização de mercado.
</Card>

<Card title="Conversão de moeda" icon="arrow-left-right" href="exchange-rates/convert">
  O endpoint `convert` converte montantes específicos entre moedas utilizando as taxas de câmbio mais atualizadas — perfeito para aplicações financeiras e plataformas de e-commerce.
</Card>

<Card title="Símbolos de moeda disponíveis" icon="circle-dollar-sign" href="exchange-rates/symbols">
  O endpoint `symbols` fornece um catálogo abrangente de moedas suportadas com descrições detalhadas, facilitando a seleção dinâmica de moeda e validação em aplicações.
</Card>

### Arquitetura REST

A API de taxas de câmbio segue os princípios REST, utilizando URLs previsíveis e orientadas a recursos e códigos de estado HTTP padrão para integração fluida e tratamento de erros.

### Segurança HTTPS

Todas as comunicações da API são protegidas com protocolos de encriptação TLS 1.2 ou superior para garantir a integridade e privacidade dos dados.

### Versionamento da API

A API de taxas de câmbio mantém compatibilidade retroativa através de versionamento, operando atualmente na Versão 1 com melhorias futuras planeadas.

### Autenticação

A sua chave API serve como credencial exclusiva para aceder à API de taxas de câmbio. Cada serviço Cleariflow requer uma chave única, garantindo acesso seguro e isolado entre diferentes APIs.

## Códigos de resposta e erro

Quando os pedidos falham, a API devolve respostas de erro JSON estruturadas com códigos e descrições específicos para resolução eficaz de problemas.

| Code | Type                  | Detalhes                                                                                                                                                                  |
| ---- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 200  | OK                    | Tudo funcionou como esperado.                                                                                                                                             |
| 204  | OK                    | Não existem dados de localização para o IP enviado.                                                                                                                       |
| 400  | Bad request           | Pedido inválido.                                                                                                                                                          |
| 401  | Unauthorized          | O pedido não foi aceite — normalmente devido a uma chave API em falta ou incorreta.                                                                                       |
| 422  | Quota reached         | O pedido foi abortado devido a créditos API insuficientes (planos gratuitos).                                                                                             |
| 429  | Too many requests     | O pedido foi abortado porque foi atingido o número de pedidos permitidos por segundo. Isto acontece em planos gratuitos, pois os pedidos estão limitados a 1 por segundo. |
| 500  | Internal server error | O pedido não pôde ser concluído devido a um erro no servidor.                                                                                                             |
| 503  | Service unavailable   | O servidor estava indisponível.                                                                                                                                           |
