Utilização do User-Agent no PlugBoleto API

Prezado cliente, informamos que implementamos uma camada adicional de segurança em nossa API utilizando WAF (Web Application Firewall). Essa proteção é importante para garantir a integridade e disponibilidade dos nossos serviços.

Devido a isto, em alguns cenários, dependendo da linguagem ou da biblioteca utilizada na integração, se faz necessário informar explicitamente o header User-Agent nas requisições, caso contrário, haverá a incidência do retorno "HTTP 403/423/523 – Locked".

A seguir, você encontra:

• Quando esse ajuste é necessário?
• Como corrigir
• Exemplos de implementação
  • cURL
  • Node.js (Axios)
  • Python (Requests)
  • PHP (cURL)
  • Java (HttpURLConnection)
• Boas práticas
• Precisa de ajuda?

🔎 Quando esse ajuste é necessário?

Se ao consumir nossa API você receber o seguinte retorno:

• HTTP 403 - Forbidden
• HTTP 423/523 – Locked

Isso pode indicar que sua requisição foi bloqueada pelo WAF por não conter um User-Agent válido.

✅ Como corrigir

Para resolver, basta adicionar o header User-Agent na sua requisição HTTP.

Esse header identifica a aplicação cliente que está realizando a chamada e é utilizado como critério de liberação pelo WAF.

🧩 Exemplos de implementação

Veja abaixo alguns exemplos de como adicionar o header em diferentes linguagens e ferramentas:

🔹 cURL

curl -X GET "https://api.seudominio.com/rota" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "User-Agent: MinhaAplicacao/1.0"

🔹 Node.js (Axios)

const axios = require('axios');

axios.get('https://api.seudominio.com/rota', {
  headers: {
    'Authorization': 'Bearer SEU_TOKEN',
    'User-Agent': 'MinhaAplicacao/1.0'
  }
})
.then(response => console.log(response.data))
.catch(error => console.error(error));

🔹 Python (Requests)

import requests

url = "https://api.seudominio.com/rota"
headers = {
    "Authorization": "Bearer SEU_TOKEN",
    "User-Agent": "MinhaAplicacao/1.0"
}

response = requests.get(url, headers=headers)
print(response.json())

🔹 PHP (cURL)

<?php

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, "https://api.seudominio.com/rota");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer SEU_TOKEN",
    "User-Agent: MinhaAplicacao/1.0"
]);

$response = curl_exec($ch);
curl_close($ch);

echo $response;

🔹 Java (HttpURLConnection)

import java.net.HttpURLConnection;
import java.net.URL;

URL url = new URL("https://api.seudominio.com/rota");
HttpURLConnection conn = (HttpURLConnection) url.openConnection();

conn.setRequestMethod("GET");
conn.setRequestProperty("Authorization", "Bearer SEU_TOKEN");
conn.setRequestProperty("User-Agent", "MinhaAplicacao/1.0");

int responseCode = conn.getResponseCode();

⚠️ Boas práticas

• Utilize um valor de User-Agent que identifique sua aplicação (ex: NomeDoSistema/Linguagem) ou a biblioteca utilizada para realizar a comunicação.
• Evite deixar esse header vazio ou com valores genéricos
• Caso utilize bibliotecas HTTP, verifique se elas já enviam um User-Agent por padrão

💬 Precisa de ajuda?

Se mesmo após essa configuração o problema persistir, entre em contato com nosso suporte informando:

• A linguagem utilizada
• A biblioteca/framework
• O trecho de código da requisição (se possível)
• O erro retornado pela API