{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"06f6a130-9930-4f5a-913e-394604383661","name":"Optime","description":"## Arquitectura: Hexagonal + Vertical Slicing + Screaming\n\nOptime API está diseñada utilizando los principios de arquitectura hexagonal, lo que significa que está organizada en capas desacopladas para facilitar su mantenimiento, escalabilidad y pruebas. Esta arquitectura también incorpora vertical slicing para estructurar el código en funciones por características y screaming architecture para asegurar que el dominio sea el aspecto más evidente del diseño.\n\n1. Dominio (Domain)\n    \n\n---\n\nEl dominio es el núcleo de la aplicación, donde se definen las reglas y la lógica de negocio. Es completamente independiente de las tecnologías subyacentes como bases de datos o servidores. Aquí se encuentran las entidades, interfaces de repositorios y excepciones del dominio.\n\n**Archivos Clave:** - **Entidades:** Clases que representan los datos principales de la aplicación, como `Notification`, `Payment`, `User`. Ejemplo: `src/notifications/domain/Notification.py`\n\n```\n- **Interfaces de Repositorio:** Definen cómo se accede y manipulan los datos en el almacenamiento sin preocuparse por su implementación.\n  Ejemplo: `src/notifications/domain/NotificationRepository.py`\n- **Excepciones:** Manejan errores específicos del dominio para mantener la consistencia en las reglas de negocio.\n  Ejemplo: `src/notifications/domain/exceptions.py`\n\n ```\n\n1. Aplicación (Application)\n    \n\n---\n\nEsta capa es responsable de coordinar los casos de uso de la lógica del dominio. Los casos de uso utilizan las entidades del dominio para ejecutar las operaciones necesarias y siguen siendo independientes de la infraestructura (bases de datos, APIs, etc.).\n\n**Archivos Clave:** - **Casos de Uso:** Clases que implementan la lógica para manejar acciones específicas como crear o modificar notificaciones. Ejemplo: `src/notifications/application/NotificationCreator.py`\n\n```\n- **Aplicación de Servicios:** Orquestación de operaciones que interactúan con varias entidades del dominio.\n  Ejemplo: `src/notifications/application/NotificationSender.py`\n\n ```\n\n1. Infraestructura (Infrastructure)\n    \n\n---\n\nEsta capa contiene la implementación concreta de los detalles técnicos como la persistencia de datos (bases de datos), peticiones HTTP y la integración con servicios externos (Mercado Pago, APIs de mensajería, etc.).\n\n**Archivos Clave:** - **Adaptadores de Repositorio:** Implementaciones de las interfaces de repositorio que conectan con la base de datos. Ejemplo: `src/notifications/infrastructure/MySqlNotificationRepository.py`\n\n```\n- **Controladores HTTP:** Gestionan las peticiones y respuestas HTTP, exponiendo los endpoints de la API.\n  Ejemplo: `src/notifications/infrastructure/NotificationRoutes.py`\n- **Conexión a Servicios Externos:** Implementaciones que permiten la interacción con APIs externas como Mercado Pago.\n  Ejemplo: `src/payments/infrastructure/PaymentRoutes.py`\n- **Configuraciones de Base de Datos:** Configura la conexión y detalles de la base de datos.\n  Ejemplo: `src/config/database.py`\n\n ```\n\n# Guía de Instalación y Ejecución\n\n**Requerimientos:**\n\n- MySQL Server\n    \n- Python 3.11\n    \n- Ngrok\n    \n\n**Pasos para la Instalación:**\n\n1. Clonar el repositorio: `git clone`\n    \n2. Crear un entorno virtual: `python -m venv venv`\n    \n3. Activar el entorno virtual:\n    \n    - Windows: `venv\\Scripts�ctivate`\n        \n    - macOS/Linux: `source venv/bin/activate`\n        \n4. Instalar las dependencias: `pip install -r requirements.txt`\n    \n5. Ejecutar el script `config/create_db_user.sql` en tu administrador de base de datos.\n    \n6. Crear el archivo `.env` utilizando el ejemplo proporcionado en el proyecto.\n    \n7. Configurar los tokens de acceso de servicios externos como Mercado Pago o Meta API en tu archivo `.env`.\n    \n8. Ejecutar las migraciones de la base de datos: `alembic upgrade head`\n    \n9. Iniciar ngrok para exponer tu aplicación: `ngrok http 8000`.\n    \n10. Agregar el URL de ngrok en el archivo `.env`.\n    \n11. Iniciar la aplicación: `uvicorn main:app --reload`\n    \n12. Testear los endpoints utilizando Postman: [Documentación de Postman Api-Optime](https://documenter.getpostman.com/view/30415321/2sAXxLBZW6#79b970a8-df6b-486c-936c-eb714da4815cT)\n    \n\n**Ejecución de Pruebas:** Para ejecutar los tests:\n\n1. Ejecutar `pytest` en el directorio raíz del proyecto para correr las pruebas unitarias.\n    \n2. Integración con GitHub Actions para la ejecución automática de tests en cada push o pull request.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"30415321","team":6480673,"collectionId":"06f6a130-9930-4f5a-913e-394604383661","publishedId":"2sAXxLBZW6","public":true,"publicUrl":"https://documenter-api.postman.tech/view/30415321/2sAXxLBZW6","privateUrl":"https://go.postman.co/documentation/30415321-06f6a130-9930-4f5a-913e-394604383661","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-single-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"dark","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2024-10-03T07:39:44.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/6a8f0a87f0e2c20864e15fbd2a56192330e58efe210f7d73185fc51f651c3130","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sAXxLBZW6"}