API de Consulta de Bilhete de Identidade

Visão Geral

<p>A API de Consulta de Bilhete de Identidade (BI) permite consultar dados de cidadãos angolanos através do número do Bilhete de Identidade.</p>

Funcionalidades

<ul>
    <li>Consulta de dados pessoais (nome, endereço, data de nascimento)</li>
    <li>Respostas rápidas e confiáveis</li>
    <li>Cache integrado para melhor performance</li>
    <li>Documentação completa e exemplos práticos</li>
</ul>

Casos de Uso

<ul>
    <li>Verificação de identidade em sistemas de validação</li>
    <li>Integração com sistemas de cadastro</li>
    <li>Consulta de dados de clientes</li>
    <li>Validação de documentos</li>
</ul>

Autenticação

Como obter uma chave de API

<p>Para utilizar a API de Consulta de Bilhete de Identidade, você precisa de uma chave de API válida.</p>

Passo 1: Solicitar chave

<p>Entre em contacto através do <a href="/contacto" style="color: var(--accent);">formulário de contacto</a> para solicitar sua chave de API.</p>

Passo 2: Receber chave

<p>Você receberá uma chave no formato:</p>
<pre><code>pk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxxxxxxxxxxxx</code></pre>

Passo 3: Utilizar chave

<p>A chave deve ser enviada em todas as requisições no header:</p>
<pre><code>X-API-Key: sua-chave-aqui</code></pre>

Exemplo de requisição autenticada

<pre><code>curl -X GET "https://portfolio-joaotomas.test/api/gateway/consulta-bi/consultar/009261732KS048" \
  -H "X-API-Key: pk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxxxxxxxxxxxx" \
  -H "Accept: application/json"</code></pre>

Códigos de erro de autenticação

<table>
    <thead>
        <tr>
            <th>Código</th>
            <th>Descrição</th>
        </tr>
    </thead>
    <tbody>
        <tr>
            <td>401</td>
            <td>Chave de API inválida ou não fornecida</td>
        </tr>
        <tr>
            <td>403</td>
            <td>Permissão negada</td>
        </tr>
        <tr>
            <td>429</td>
            <td>Muitas requisições (rate limit excedido)</td>
        </tr>
    </tbody>
</table>

Endpoints Disponíveis

Consultar Bilhete de Identidade

Endpoint

<pre><code>GET /consultar/{numero}</code></pre>

Parâmetros

<table>
    <thead>
        <tr>
            <th>Parâmetro</th>
            <th>Tipo</th>
            <th>Obrigatório</th>
            <th>Descrição</th>
        </tr>
    </thead>
    <tbody>
        <tr>
            <td>numero</td>
            <td>string</td>
            <td>Sim</td>
            <td>Número do Bilhete de Identidade (14 caracteres)</td>
        </tr>
    </tbody>
</table>

Exemplo de requisição

<pre><code>curl -X GET "https://portfolio-joaotomas.test/api/gateway/consulta-bi/consultar/009261732KS048" \
  -H "X-API-Key: sua-chave-aqui" \
  -H "Accept: application/json"</code></pre>

Resposta de sucesso

<pre><code>{
  "error": false,
  "name": "Lisboa Da Costa Coelho",
  "endereco": "SAMBA, NA, BAIRRO MUNDIAL-BENFICA",
  "data_de_nascimento": "1991-07-31"
}</code></pre>

Resposta de erro

<pre><code>{
  "error": true,
  "message": "O número do documento deve conter 14 caracteres"
}</code></pre>

Limitações

<ul>
    <li><strong>Rate Limit:</strong> 100 requisições por minuto</li>
    <li><strong>Cache:</strong> As respostas são cacheadas por 1 hora</li>
    <li><strong>Tamanho máximo:</strong> 1MB por requisição</li>
</ul>

Exemplos Práticos

Exemplo em PHP

<pre><code>&lt;?php

function consultarBI($numero, $apiKey) {
    $ch = curl_init('https://portfolio-joaotomas.test/api/gateway/consulta-bi/consultar/' . $numero);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($ch, CURLOPT_HTTPHEADER, [
        'X-API-Key: ' . $apiKey,
        'Accept: application/json'
    ]);
    
    $response = curl_exec($ch);
    curl_close($ch);
    
    return json_decode($response, true);
}

// Uso
$apiKey = 'pk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxxxxxxxxxxxx';
$dados = consultarBI('009261732KS048', $apiKey);

if (!$dados['error']) {
    echo "Nome: " . $dados['name'] . "\n";
    echo "Endereço: " . $dados['endereco'] . "\n";
    echo "Data Nascimento: " . $dados['data_de_nascimento'] . "\n";
}
</code></pre>

Exemplo em JavaScript (Node.js)

<pre><code>const axios = require('axios');

async function consultarBI(numero, apiKey) {
    try {
        const response = await axios.get(
            `https://portfolio-joaotomas.test/api/gateway/consulta-bi/consultar/${numero}`,
            {
                headers: {
                    'X-API-Key': apiKey,
                    'Accept': 'application/json'
                }
            }
        );
        return response.data;
    } catch (error) {
        return { error: true, message: 'Erro na requisição' };
    }
}

// Uso
const apiKey = 'pk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxxxxxxxxxxxx';
const dados = await consultarBI('009261732KS048', apiKey);

if (!dados.error) {
    console.log('Nome:', dados.name);
    console.log('Endereço:', dados.endereco);
    console.log('Data Nascimento:', dados.data_de_nascimento);
}
</code></pre>

Exemplo em JavaScript (Frontend)

<pre><code>async function consultarBI(numero, apiKey) {
    try {
        const response = await fetch(
            `https://portfolio-joaotomas.test/api/gateway/consulta-bi/consultar/${numero}`,
            {
                headers: {
                    'X-API-Key': apiKey,
                    'Accept': 'application/json'
                }
            }
        );
        return await response.json();
    } catch (error) {
        return { error: true, message: 'Erro na requisição' };
    }
}

// Uso
const apiKey = 'pk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxxxxxxxxxxxx';
const dados = await consultarBI('009261732KS048', apiKey);

if (!dados.error) {
    document.getElementById('nome').textContent = dados.name;
    document.getElementById('endereco').textContent = dados.endereco;
    document.getElementById('data').textContent = dados.data_de_nascimento;
}
</code></pre>

Erros Comuns e FAQ

Códigos de Erro

<table>
    <thead>
        <tr>
            <th>Código</th>
            <th>Descrição</th>
            <th>Solução</th>
        </tr>
    </thead>
    <tbody>
        <tr>
            <td>200</td>
            <td>Sucesso</td>
            <td>-</td>
        </tr>
        <tr>
            <td>400</td>
            <td>Requisição inválida</td>
            <td>Verifique os parâmetros enviados</td>
        </tr>
        <tr>
            <td>401</td>
            <td>Não autorizado</td>
            <td>Verifique sua chave de API</td>
        </tr>
        <tr>
            <td>403</td>
            <td>Permissão negada</td>
            <td>Sua chave não tem permissão para este recurso</td>
        </tr>
        <tr>
            <td>404</td>
            <td>Recurso não encontrado</td>
            <td>Verifique o número do documento</td>
        </tr>
        <tr>
            <td>429</td>
            <td>Muitas requisições</td>
            <td>Aguarde e tente novamente</td>
        </tr>
        <tr>
            <td>500</td>
            <td>Erro interno</td>
            <td>Contacte o suporte</td>
        </tr>
    </tbody>
</table>

FAQ

1. Como obtenho uma chave de API?

<p>Entre em contacto através do <a href="/contacto" style="color: var(--accent);">formulário de contacto</a> no site.</p>

2. Qual é o limite de requisições?

<p>O limite padrão é de 100 requisições por minuto.</p>

3. Os dados são cacheados?

<p>Sim, as respostas são cacheadas por 1 hora para melhor performance.</p>

4. Como identifico um erro?

<p>Todas as respostas de erro contêm um campo <code>error: true</code> e uma mensagem descritiva.</p>

5. A API é gratuita?

<p>Contacte para informações sobre planos e preços.</p>

Contacto

<p>Para suporte ou dúvidas: <a href="/contacto" style="color: var(--accent);">Formulário de Contacto</a></p>