Documentación General de Paladins APIs

Bienvenido a la documentación oficial de Paladins APIs. Nuestra plataforma ofrece un ecosistema unificado de servicios web RESTful para interactuar de forma automatizada y segura con entidades mexicanas (SAT, SEP, RENAPO, TecNM) y herramientas de procesamiento de datos fiscales.

---

🌐 Entorno y URL Base

Todas las peticiones a los servicios de la API deben dirigirse a la URL base de producción:

https://bridge.paladins.mx/api/v1

NOTE

Todos los endpoints requieren comunicación segura sobre HTTPS. Las peticiones sobre HTTP no cifrado serán rechazadas.

---

🔑 Autenticación

Paladins APIs utiliza tokens de portador (Bearer Tokens) para la autenticación de cada solicitud.

¿Cómo obtener un token?

1. Crea tu cuenta o inicia sesión en la Plataforma Bridge.
2. Dirígete a la sección de Tokens o consulta la guía Generar Token de Acceso.
3. Copia el token generado y resérvalo en tus variables de entorno seguras.

Envío de cabeceras de autorización

En cada solicitud HTTP debes adjuntar el encabezado Authorization junto con el tipo de contenido:

Authorization: Bearer {TU_TOKEN_DE_ACCESO}
Accept: application/json
Content-Type: application/json

---

🚀 Guía de Inicio Rápido

1. Verificar tus credenciales

Puedes probar tu token realizando una petición al endpoint de perfil de usuario:

GET/api/v1/users

cURL

curl --location 'https://bridge.paladins.mx/api/v1/users' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer TU_TOKEN_AQUI'

Node.js (Fetch)

const response = await fetch('https://bridge.paladins.mx/api/v1/users', {
  headers: {
    'Accept': 'application/json',
    'Authorization': 'Bearer TU_TOKEN_AQUI'
  }
});

const user = await response.json();
console.log(user);

Python

import requests

res = requests.get(
    'https://bridge.paladins.mx/api/v1/users',
    headers={'Authorization': 'Bearer TU_TOKEN_AQUI', 'Accept': 'application/json'}
)
print(res.json())

2. Estructura de Respuesta Exitosa

Las respuestas con código 200 OK o 201 Created retornan objetos JSON estructurados:

{
  "id": 1,
  "name": "Miguel Angel Muñoz Pozos",
  "email": "usuario@paladins.mx",
  "email_verified_at": "2024-01-15T10:30:00.000000Z",
  "created_at": "2024-01-15T10:30:00.000000Z"
}

---

📦 Estructura de Errores y Códigos HTTP

Paladins APIs utiliza códigos de estado HTTP estándar para indicar el resultado de cada solicitud:

Código	Estado	Descripción
200 OK	Éxito	La solicitud fue procesada correctamente.
201 Created	Creado	El recurso (ej. token o usuario) se creó con éxito.
400 Bad Request	Petición Inválida	Parámetros faltantes o formato de datos incorrecto.
401 Unauthorized	No Autorizado	Token inválido, ausente o expirado.
403 Forbidden	Prohibido	No cuentas con saldo suficiente o permisos para este recurso.
422 Unprocessable	Error de Validación	Los datos enviados no cumplen con las reglas requeridas.
500 Server Error	Error Interno	Ocurrió un error en nuestros servidores o en el servicio externo.

Ejemplo de respuesta con error de validación (422)

{
  "message": "Los datos proporcionados no son válidos.",
  "errors": {
    "rfc": [
      "El campo RFC es obligatorio y debe tener formato válido."
    ]
  }
}

---

🧭 Servicios Disponibles

Explora la documentación detallada por cada módulo:

• 🏛️ Servicios SAT: Resolver Captcha, Constancia de Situación Fiscal, Opinión del Cumplimiento, CFDI a JSON, Recolectores.
• 📜 Catálogos SAT: Catálogos CFDI 4.0, Carta Porte 2.0 / 3.0 / 3.1, Retenciones, Nóminas y Comercio Exterior.
• 🎓 Cédulas SEP: Búsqueda y validación de cédulas en el Registro Nacional de Profesionistas.
• 🏫 Títulos TecNM: Validación de títulos académicos en el sistema del Tecnológico Nacional de México.
• 📄 Actas RENAPO: Validación y extracción de actas de nacimiento ante el Registro Nacional de Población.
• 💳 Tarifas y Precios: Conoce el costo por consulta de cada una de nuestras rutas.