Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/PDNMX/s1_backend/llms.txt

Use this file to discover all available pages before exploring further.

S1 Backend is the Node.js/Express server that powers Sistema 1 of Mexico’s Plataforma Digital Nacional (PDN). It acts as a unified REST API gateway — accepting queries from front-end clients and fanning them out to multiple federated government data suppliers, each of which independently holds public servant asset declaration records.

Quickstart

Clone, configure, and run your first query in minutes

Configuration

Set up your endpoints.json and environment variables

API Reference

Full reference for all five REST endpoints

Docker Deployment

Run S1 Backend in a container with Docker Compose

​
What S1 Backend Does

S1 Backend sits between PDN front-end applications and a collection of independent government data providers. Each provider exposes its own REST API secured with OAuth 2.0 (password grant). S1 Backend:
  1. Acquires OAuth tokens on demand from each configured provider.
  2. Routes and fans out search or summary requests to the relevant providers in parallel.
  3. Aggregates and normalises responses before returning them to the caller.
  4. Logs client-side events centrally for diagnostics.

Provider Registry

Learn how data suppliers are registered and identified

Data Models

Understand the endpoint config schema and response shapes

​
Key Capabilities

Cross-Provider Summary

Query record counts across all providers simultaneously, filtered by government level or institution

Paginated Search

Full-text, field-level, and range search against a single provider with sorting and pagination

Environment-Based Config

All sensitive credentials live in environment variables — never in source code

Structured Logging

Ingest front-end log events server-side via the /v1/logger endpoint

​
Quick Overview

GET  /                 → API title and version
GET  /v1/providers     → List all configured data suppliers
POST /v1/summary       → Record counts from all matching providers
POST /v1/search        → Paginated search against one provider
POST /v1/logger        → Log client-side events server-side
S1 Backend requires an endpoints.json file at the project root containing credentials and URLs for each data provider. See Configuration for the full schema.

Build docs developers (and LLMs) love

Get started for freeTalk to us