Autenticación - API Firmaris

Para usar la API Firmaris es obligatorio identificarse. Esto permite al sistema saber quién eres, a qué empresa perteneces y qué permisos tienes.

La autenticación se realiza mediante un header HTTP llamado x-api-key.

---

Credenciales de acceso

Para integrar la API de Firmaris, primero debes obtener tu API Key desde tu cuenta de administrador.

Paso a paso

1. Inicia sesión en tu cuenta de administrador.
2. Dirígete al panel Mi cuenta.
3. Ubica la sección de API Key.
4. Copia la clave y guárdala en un lugar seguro, ya que será necesaria para autenticar todas las peticiones a la API.

🔐 Importante

• No compartas tu API Key públicamente.

---

Ejemplo de Header

x-api-key: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

---

Reglas importantes

• La palabra Bearer es obligatoria
• Debe existir un espacio entre Bearer y el token
• El token no debe modificarse

---

¿Qué pasa si no envío el token?

La API responderá con un error 401 - Unauthorized.

{
  "success": false,
  "status": 401,
  "message": "Autenticación requerida"
}

---

¿Qué pasa si el token es inválido o no tiene permisos?

La API responderá con un error 403 - Forbidden.

{
  "success": false,
  "status": 403,
  "message": "Acceso denegado. No tiene los permisos necesarios para acceder a este recurso."
}

---

Ejemplo usando cURL

curl -X GET https://api.firmaris.co/endpoint \
  -H "x-api-key: Bearer TU_TOKEN_DE_EMPRESA"

---

Ejemplo usando JavaScript (fetch)

fetch('https://api.firmaris.co/endpoint', {
  method: 'GET',
  headers: {
    'x-api-key': 'Bearer TU_TOKEN_DE_EMPRESA',
    'Content-Type': 'application/json'
  }
})
.then(response => response.json())
.then(data => console.log(data));

---

Ejemplo usando PHP (cURL)

$ch = curl_init();

curl_setopt_array($ch, [
  CURLOPT_URL => 'https://api.firmaris.co/endpoint',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'x-api-key: Bearer TU_TOKEN_DE_EMPRESA',
    'Content-Type: application/json'
  ],
]);

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

echo $response;

---

Recomendaciones de Seguridad

• Nunca compartas tu token públicamente
• No lo incluyas directamente en el código
• Usa variables de entorno
• Si sospechas que fue comprometido, solicita uno nuevo al soporte técnico de Firmaris

---

Resumen rápido

• El header x-api-key es obligatorio
• Debe enviarse en todas las solicitudes
• Sin token → error 401
• Token inválido o sin permisos → error 403