Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/juanfranciscocis/vercelcortesapi
https://github.com/juanfranciscocis/vercelcortesapi
Last synced: 13 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/juanfranciscocis/vercelcortesapi
- Owner: juanfranciscocis
- Created: 2024-11-17T22:07:36.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-12-15T18:12:03.000Z (18 days ago)
- Last Synced: 2024-12-15T19:24:06.986Z (18 days ago)
- Language: Python
- Size: 734 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Vercel Cortes API
**¡Bienvenido a la API que ayuda a los quiteños a mantenerse informados sobre los cortes de luz! 💡**
## 🚀 Descripción del Proyecto
**Vercel Cortes API** es una herramienta creada con Flask que realiza **web scraping** y **PDF scraping** en la página oficial de la Empresa Eléctrica de Quito. El propósito es proporcionar información sobre los cortes de energía eléctrica en Quito basándose en la zona ingresada por el usuario.
### 🧐 ¿Qué hace esta API?
Al enviar una consulta con el nombre de una zona, la API devuelve detalles sobre los cortes programados en esa ubicación.
**Prueba la API aquí:**
👉 [https://vercel-cortes-api.vercel.app/api?zona=cumbaya](https://vercel-cortes-api.vercel.app/api?zona=cumbaya)
### 🗣️ Alexa Skill Integrado
Además, esta API está integrada con un **Skill de Alexa**, que permite a los usuarios preguntar:
**"¿Cuándo será el próximo corte de luz en mi [zona]?"**
Alexa consulta la API y responde con la información correspondiente.
---
## 📄 Documentación de la API
### Endpoint Principal
**GET** `/api`
#### Parámetros
| Parámetro | Tipo | Descripción | Obligatorio |
|-----------|--------|----------------------------------------------|-------------|
| `zona` | String | Nombre de la zona para consultar los cortes. | Sí |
#### Ejemplo de Uso
```curl "https://vercel-cortes-api.vercel.app/api?zona=cumbaya" ```
RESPUESTA
```
{"data":
{
"horarios":["0:00 - 04:00","12:00 - 16:00"],
"zona":"cumbaya",
"fecha":[21,"noviembre",2024]
}
}
```
**GET** `/api/specific_date`
#### Parámetros
| Parámetro | Tipo | Descripción | Obligatorio |
|-----------|--------|----------------------------------------------|-------------|
| `zona` | String | Nombre de la zona para consultar los cortes. | Sí |
| `dia` | String | Día del mes para consultar los cortes. | Sí |
#### Ejemplo de Uso
```curl "https://vercel-cortes-api.vercel.app/api/specific_date?zona=cumbaya&dia=21" ```
RESPUESTA
```
{"data":
{
"horarios":["0:00 - 04:00","12:00 - 16:00"],
"zona":"cumbaya",
"fecha":[21,"noviembre",2024]
}
}
```
## 🛠️ Cómo Colaborar
¡Este proyecto es open source y toda colaboración es bienvenida! Aquí tienes cómo puedes participar:
Si tienes ideas o experiencia en scraping, optimización de APIs, o nuevos enfoques para este tipo de proyectos, ¡anímate a contribuir!
Para colaborar:
1. Realiza un fork del proyecto.
2. Crea una rama con tu funcionalidad o mejora
3. Realiza un pull request (PR).
## Usar la API en tus proyectos
La API está disponible para todos. Úsala en aplicaciones móviles, otros Skills de Alexa o sistemas de monitoreo. **NO ABUSES CON LAS PETICIONES**
## Probar el Skill de Alexa
Únete a la beta pública del Skill.
Envíame un mensaje directo para incluirte. 🙌
## 📧 Contacto
Autor: Juan Francisco Cisneros
Correo: [email protected]
GitHub: juanfranciscocis
LinkedIn: [Juan Francisco Cisneros](www.linkedin.com/in/juanfranciscocisneros)