La API fue construida con Django y la librería Django Rest Framework. Permite crear cuentas, a las cuales se les puede asociar perfiles. Un perfil se refiere al rol que tiene un cliente respecto a una cuenta. Por ejemplo, la cuenta C, es compartida por los clientes A y B, dónde el cliente A es el propietario de la cuenta y el B, es beneficiario. Por lo tanto ambos clientes A y B, pueden realizar transacciones con una misma cuenta.
- Modelo BD
| # | Nombre | Tipo | Link | URL | Descripción |
|---|---|---|---|---|---|
| 1 | Cuenta List | GET | cuenta | /cuenta/ | Lista las cuentas creadas y permite crear una nueva cuenta. |
| 2 | Cuenta Detail | GET/POST/DELETE/PUT | cuenta id | /cuenta/{id} | Lista la cuenta correspondiente al id. Permite modificar y eliminar cuentas. |
| 3 | Transaccion List | GET | transaccion | /transaccion/ | Lista las transacciones creadas y permite crear una nueva transacción. |
| 4 | Transaccion Detail | GET/POST/DELETE/PUT | transaccion id | /transaccion/{id} | Lista la transacción correspondiente al id. Permite modificar y eliminar transacciones. |
| 5 | Perfil List | GET | perfil | /perfil/ | Lista los perfiles creados y permite crear un nuevo perfil. |
| 6 | Perfil Detail | GET/POST/DELETE/PUT | perfil id | /perfil/{id} | Lista el perfil correspondiente al id. Permite modificar y eliminar perfiles. |
| 7 | Cliente List | GET | cliente | /cliente/ | Lista los clientes creados y permite crear un nuevo cliente. |
| 8 | Cliente Detail | GET/POST/DELETE/PUT | cliente id | /cliente/{id} | Lista el cliente correspondiente al id. Permite modificar y eliminar clientes. |
| 9 | Add Money | PUT | add money | /add_money/ | Permite añadir una cantidad de dinero, bien sea negativa o positiva a una cuenta. Recibe un json formado por el id de la cuenta y el valor a añadir, con la siguiente estructura: { 'id': 1, 'deposit' : 50000 } |
| 10 | Set zero | POST | set zero | /set_zero/ | Modifica el saldo de la cuenta relacionada con el id que recibe, dejandolo en cero. Recibe un json con el id de la cuenta, así: { 'id' : 1 } |
| 11 | List tran | GET | list tran | /list_tran/{id} | Lista las transacciones de la cuenta relacionada con el id que recibe a través de la url |
- git clone https://github.com/jsparadacelis/api_cuenta.git
- cd api_cuenta
- sudo docker-compose up
- entrar a http://0.0.0.0:8000/ desde el navegador
¡ Y listo !
Para mayor información: Documento API