# fernandobriozzo/api-bot architecture

> Architecture diagram of the GitHub repository fernandobriozzo/api-bot, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-19). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/fernandobriozzo/api-bot
- Repository: https://github.com/fernandobriozzo/api-bot

## Overview

This Laravel application exposes authenticated APIs for bot-driven CVF and Mi Pieza lookups, territorial data (including barrio geometry and administrative hierarchy), RENAPER endpoints, and downloadable barrio/person update archives. The main workflow is an API request routed to a controller, which queries domain models or the ARSAT data connection and returns JSON. The route and sampled controller/model excerpts support the shown dispatches and calls; RENAPER internals and several other controllers were not sampled, so their downstream behavior is not inferred.

Main entry points: [`routes/api.php`](https://github.com/fernandobriozzo/api-bot/blob/main/routes/api.php) (API routes), [`app/Http/Controllers/BotController.php`](https://github.com/fernandobriozzo/api-bot/blob/main/app/Http/Controllers/BotController.php) (Bot endpoints), [`app/Models/Apis/Barrio.php`](https://github.com/fernandobriozzo/api-bot/blob/main/app/Models/Apis/Barrio.php) (Barrio model), [`app/Http/Controllers/BarrioController.php`](https://github.com/fernandobriozzo/api-bot/blob/main/app/Http/Controllers/BarrioController.php) (Barrio endpoints)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_http["API routing"]
  node_routes["API routes<br/>[api.php]"]
end

subgraph group_bot["Bot services"]
  node_botctl["Bot endpoints<br/>[BotController.php]"]
  node_piecectl["Mi Pieza endpoints"]
  node_cvf["CVF records<br/>[CVF.php]"]
  node_reclamo["Claims<br/>[Reclamo.php]"]
  node_encuesta["Survey records<br/>[Encuesta.php]"]
  node_user["Bot users<br/>[User.php]"]
  node_pieza["Mi Pieza records<br/>[Mipieza.php]"]
  node_inscripcion["Enrollment state<br/>[Inscripcion.php]"]
end

subgraph group_territory["Territorial data"]
  node_barrioc["Barrio endpoints"]
  node_provincia["Province endpoints"]
  node_departamento["Department endpoints"]
  node_localidad["Locality endpoints"]
  node_barrio["Barrio model<br/>[Barrio.php]"]
  node_provmodel["Province model<br/>[Provincia.php]"]
  node_depmodel["Department model<br/>[Departamento.php]"]
  node_locmodel["Locality model<br/>[Localidad.php]"]
  node_arsat[("ARSAT database")]
end

subgraph group_archives["Update archives"]
  node_zipctl["Update endpoints"]
  node_zipmodels["Archive data models"]
end

subgraph group_integrations["External data"]
  node_renaperctl["RENAPER endpoints"]
  node_renaper["RENAPER service"]
end

node_caller(("API clients"))

node_caller -->|"requests"| node_routes
node_routes -->|"dispatches"| node_botctl
node_routes -->|"dispatches"| node_piecectl
node_routes -->|"dispatches"| node_barrioc
node_routes -->|"dispatches"| node_provincia
node_routes -->|"dispatches"| node_departamento
node_routes -->|"dispatches"| node_localidad
node_routes -->|"dispatches"| node_zipctl
node_routes -->|"dispatches"| node_renaperctl
node_botctl -->|"authenticates"| node_user
node_botctl -->|"looks up"| node_cvf
node_botctl -->|"looks up"| node_reclamo
node_botctl -->|"looks up"| node_encuesta
node_piecectl -->|"queries"| node_pieza
node_piecectl -->|"checks state"| node_inscripcion
node_barrioc -->|"queries"| node_barrio
node_barrioc -->|"lists provinces"| node_provmodel
node_barrioc -->|"queries"| node_arsat
node_barrio -->|"looks up locality"| node_locmodel
node_barrio -->|"looks up department"| node_depmodel
node_barrio -->|"looks up province"| node_provmodel
node_provincia -->|"queries"| node_provmodel
node_provincia -->|"queries"| node_depmodel
node_departamento -->|"queries"| node_depmodel
node_departamento -->|"queries"| node_locmodel
node_localidad -->|"queries"| node_locmodel
node_localidad -->|"queries"| node_barrio
node_zipctl -->|"queries and builds"| node_zipmodels
node_renaperctl -.->|"integrates with"| node_renaper

click node_routes "https://github.com/fernandobriozzo/api-bot/blob/main/routes/api.php"
click node_botctl "https://github.com/fernandobriozzo/api-bot/blob/main/app/Http/Controllers/BotController.php"
click node_piecectl "https://github.com/fernandobriozzo/api-bot/blob/main/app/Http/Controllers/PiezaController.php"
click node_cvf "https://github.com/fernandobriozzo/api-bot/blob/main/app/Models/CVF.php"
click node_reclamo "https://github.com/fernandobriozzo/api-bot/blob/main/app/Models/Reclamo.php"
click node_encuesta "https://github.com/fernandobriozzo/api-bot/blob/main/app/Models/Encuesta.php"
click node_user "https://github.com/fernandobriozzo/api-bot/blob/main/app/Models/User.php"
click node_pieza "https://github.com/fernandobriozzo/api-bot/blob/main/app/Models/Mipieza.php"
click node_inscripcion "https://github.com/fernandobriozzo/api-bot/blob/main/app/Models/Inscripcion.php"
click node_barrioc "https://github.com/fernandobriozzo/api-bot/blob/main/app/Http/Controllers/BarrioController.php"
click node_provincia "https://github.com/fernandobriozzo/api-bot/blob/main/app/Http/Controllers/ProvinciaController.php"
click node_departamento "https://github.com/fernandobriozzo/api-bot/blob/main/app/Http/Controllers/DepartamentoController.php"
click node_localidad "https://github.com/fernandobriozzo/api-bot/blob/main/app/Http/Controllers/LocalidadController.php"
click node_barrio "https://github.com/fernandobriozzo/api-bot/blob/main/app/Models/Apis/Barrio.php"
click node_provmodel "https://github.com/fernandobriozzo/api-bot/blob/main/app/Models/Apis/Provincia.php"
click node_depmodel "https://github.com/fernandobriozzo/api-bot/blob/main/app/Models/Apis/Departamento.php"
click node_locmodel "https://github.com/fernandobriozzo/api-bot/blob/main/app/Models/Apis/Localidad.php"
click node_zipctl "https://github.com/fernandobriozzo/api-bot/blob/main/app/Http/Controllers/novedadesController.php"
click node_zipmodels "https://github.com/fernandobriozzo/api-bot/tree/main/app/Models/Apis"
click node_renaperctl "https://github.com/fernandobriozzo/api-bot/blob/main/app/Http/Controllers/RenaperController.php"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_routes,node_caller toneBlue
class node_botctl,node_piecectl,node_cvf,node_reclamo,node_encuesta,node_user,node_pieza,node_inscripcion toneAmber
class node_barrioc,node_provincia,node_departamento,node_localidad,node_barrio,node_provmodel,node_depmodel,node_locmodel,node_arsat toneMint
class node_zipctl,node_zipmodels toneRose
class node_renaperctl,node_renaper toneIndigo
```

## Components

### API routing

- [API routes](https://github.com/fernandobriozzo/api-bot/blob/main/routes/api.php): `routes/api.php`

### Bot services

- [Bot endpoints](https://github.com/fernandobriozzo/api-bot/blob/main/app/Http/Controllers/BotController.php): `app/Http/Controllers/BotController.php`
- [Mi Pieza endpoints](https://github.com/fernandobriozzo/api-bot/blob/main/app/Http/Controllers/PiezaController.php): `app/Http/Controllers/PiezaController.php`
- [CVF records](https://github.com/fernandobriozzo/api-bot/blob/main/app/Models/CVF.php): `app/Models/CVF.php`
- [Claims](https://github.com/fernandobriozzo/api-bot/blob/main/app/Models/Reclamo.php): `app/Models/Reclamo.php`
- [Survey records](https://github.com/fernandobriozzo/api-bot/blob/main/app/Models/Encuesta.php): `app/Models/Encuesta.php`
- [Bot users](https://github.com/fernandobriozzo/api-bot/blob/main/app/Models/User.php): `app/Models/User.php`
- [Mi Pieza records](https://github.com/fernandobriozzo/api-bot/blob/main/app/Models/Mipieza.php): `app/Models/Mipieza.php`
- [Enrollment state](https://github.com/fernandobriozzo/api-bot/blob/main/app/Models/Inscripcion.php): `app/Models/Inscripcion.php`

### Territorial data

- [Barrio endpoints](https://github.com/fernandobriozzo/api-bot/blob/main/app/Http/Controllers/BarrioController.php): `app/Http/Controllers/BarrioController.php`
- [Province endpoints](https://github.com/fernandobriozzo/api-bot/blob/main/app/Http/Controllers/ProvinciaController.php): `app/Http/Controllers/ProvinciaController.php`
- [Department endpoints](https://github.com/fernandobriozzo/api-bot/blob/main/app/Http/Controllers/DepartamentoController.php): `app/Http/Controllers/DepartamentoController.php`
- [Locality endpoints](https://github.com/fernandobriozzo/api-bot/blob/main/app/Http/Controllers/LocalidadController.php): `app/Http/Controllers/LocalidadController.php`
- [Barrio model](https://github.com/fernandobriozzo/api-bot/blob/main/app/Models/Apis/Barrio.php): `app/Models/Apis/Barrio.php`
- [Province model](https://github.com/fernandobriozzo/api-bot/blob/main/app/Models/Apis/Provincia.php): `app/Models/Apis/Provincia.php`
- [Department model](https://github.com/fernandobriozzo/api-bot/blob/main/app/Models/Apis/Departamento.php): `app/Models/Apis/Departamento.php`
- [Locality model](https://github.com/fernandobriozzo/api-bot/blob/main/app/Models/Apis/Localidad.php): `app/Models/Apis/Localidad.php`
- **ARSAT database**

### Update archives

- [Update endpoints](https://github.com/fernandobriozzo/api-bot/blob/main/app/Http/Controllers/novedadesController.php): `app/Http/Controllers/novedadesController.php`
- [Archive data models](https://github.com/fernandobriozzo/api-bot/tree/main/app/Models/Apis): `app/Models/Apis`

### External data

- [RENAPER endpoints](https://github.com/fernandobriozzo/api-bot/blob/main/app/Http/Controllers/RenaperController.php): `app/Http/Controllers/RenaperController.php`
- **RENAPER service**

### Other components

- **API clients**

## Connections

- API clients → API routes: requests (evidence: `routes/api.php`)
- API routes → Bot endpoints: dispatches (evidence: `routes/api.php`)
- API routes → Mi Pieza endpoints: dispatches (evidence: `routes/api.php`)
- API routes → Barrio endpoints: dispatches (evidence: `routes/api.php`)
- API routes → Province endpoints: dispatches (evidence: `routes/api.php`)
- API routes → Department endpoints: dispatches (evidence: `routes/api.php`)
- API routes → Locality endpoints: dispatches (evidence: `routes/api.php`)
- API routes → Update endpoints: dispatches (evidence: `routes/api.php`)
- API routes → RENAPER endpoints: dispatches (evidence: `routes/api.php`)
- Bot endpoints → Bot users: authenticates (evidence: `app/Http/Controllers/BotController.php`)
- Bot endpoints → CVF records: looks up (evidence: `app/Http/Controllers/BotController.php`)
- Bot endpoints → Claims: looks up (evidence: `app/Http/Controllers/BotController.php`)
- Bot endpoints → Survey records: looks up (evidence: `app/Http/Controllers/BotController.php`)
- Mi Pieza endpoints → Mi Pieza records: queries (evidence: `app/Http/Controllers/PiezaController.php`)
- Mi Pieza endpoints → Enrollment state: checks state (evidence: `app/Http/Controllers/PiezaController.php`)
- Barrio endpoints → Barrio model: queries (evidence: `app/Http/Controllers/BarrioController.php`)
- Barrio endpoints → Province model: lists provinces (evidence: `app/Http/Controllers/BarrioController.php`)
- Barrio endpoints → ARSAT database: queries (evidence: `app/Http/Controllers/BarrioController.php`)
- Barrio model → Locality model: looks up locality (evidence: `app/Models/Apis/Barrio.php`)
- Barrio model → Department model: looks up department (evidence: `app/Models/Apis/Barrio.php`)
- Barrio model → Province model: looks up province (evidence: `app/Models/Apis/Barrio.php`)
- Province endpoints → Province model: queries (evidence: `app/Http/Controllers/ProvinciaController.php`)
- Province endpoints → Department model: queries (evidence: `app/Http/Controllers/ProvinciaController.php`)
- Department endpoints → Department model: queries (evidence: `app/Http/Controllers/DepartamentoController.php`)
- Department endpoints → Locality model: queries (evidence: `app/Http/Controllers/DepartamentoController.php`)
- Locality endpoints → Locality model: queries (evidence: `app/Http/Controllers/LocalidadController.php`)
- Locality endpoints → Barrio model: queries (evidence: `app/Http/Controllers/LocalidadController.php`)
- Update endpoints → Archive data models: queries and builds (evidence: `app/Http/Controllers/novedadesController.php`)
- RENAPER endpoints → RENAPER service: integrates with
