diff --git a/doc/requests.org b/doc/requests.org new file mode 100644 index 0000000..b0c38fa --- /dev/null +++ b/doc/requests.org @@ -0,0 +1,76 @@ +* Requests +Ejemplo de request contra la api usando [[https://github.com/federicotdn/verb][verb]] + +** Autenticación :verb: +template http://localhost:7000/api +Content-Type: application/json; +*** Solicitar token +post /token/ + +{ + "username": "admin", + "password": "123" +} +**** respuesta +#+begin_src json +{ + "refresh": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoicmVmcmVzaCIsImV4cCI6MTc3MTE4NzYxOSwiaWF0IjoxNzcxMTAxMjE5LCJqdGkiOiI5ZTgzNGRlM2QzMmQ0NmQyODEwZGQ2MjI2ODUwNjgzNyIsInVzZXJfaWQiOiIyIn0.JaUOqEAZ2T8vVT36mXfweMmYjEWsP7toD07jeeyrl1k", + "access": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzcxMTAzMDE5LCJpYXQiOjE3NzExMDEyMTksImp0aSI6ImFmOWFjNGM1MzBiZjQ4ZGE4Yzg2MWFjYzIzNjQ3NjU3IiwidXNlcl9pZCI6IjIifQ.6wH5sx1fyFn3Wt3DVZGYbiYi79rGthUZkgGmTqzebXc" +} +#+end_src +*** Perfil de usuario +get /users/me/ +Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzcxMTAzMDE5LCJpYXQiOjE3NzExMDEyMTksImp0aSI6ImFmOWFjNGM1MzBiZjQ4ZGE4Yzg2MWFjYzIzNjQ3NjU3IiwidXNlcl9pZCI6IjIifQ.6wH5sx1fyFn3Wt3DVZGYbiYi79rGthUZkgGmTqzebXc +**** Respuesta +#+begin_src json +{ + "id": 2, + "username": "admin", + "email": "correo@example.com", + "first_name": "", + "last_name": "" +} +#+end_src +*** Renovar token +post /token/refresh/ + +{ + "refresh": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoicmVmcmVzaCIsImV4cCI6MTc3MTE4NzYxOSwiaWF0IjoxNzcxMTAxMjE5LCJqdGkiOiI5ZTgzNGRlM2QzMmQ0NmQyODEwZGQ2MjI2ODUwNjgzNyIsInVzZXJfaWQiOiIyIn0.JaUOqEAZ2T8vVT36mXfweMmYjEWsP7toD07jeeyrl1k" +} +**** response +#+begin_src json +{ + "access": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzcxMTAzNjA1LCJpYXQiOjE3NzExMDE4MDUsImp0aSI6ImJjZTY5ZTA3MTIyOTQxMTg5NmFjYzk1ZDNiOThhMTI0IiwidXNlcl9pZCI6IjIifQ.b4Z1c_Yi5tsLZ-7F0KZcM2tai-f1VeaE881j2pKDwYA" +} +#+end_src +** Don confiao :verb: +template http://localhost:7000/don_confiao/api/ +Content-Type: application/json; +Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzcxMTAzNjA1LCJpYXQiOjE3NzExMDE4MDUsImp0aSI6ImJjZTY5ZTA3MTIyOTQxMTg5NmFjYzk1ZDNiOThhMTI0IiwidXNlcl9pZCI6IjIifQ.b4Z1c_Yi5tsLZ-7F0KZcM2tai-f1VeaE881j2pKDwYA +*** todas las rutas +get +**** response +#+begin_src json +{ + "sales": "http://localhost:7000/don_confiao/api/sales/", + "customers": "http://localhost:7000/don_confiao/api/customers/", + "products": "http://localhost:7000/don_confiao/api/products/", + "reconciliate_jar": "http://localhost:7000/don_confiao/api/reconciliate_jar/" +} +#+end_src +*** customers +get customers/ +**** response +#+begin_src json +[ + { + "id": 1, + "name": "Consumidor Final", + "address": "", + "email": "", + "phone": "", + "external_id": "2753" + }, + ... +] +#+end_src