Skip to content

Instantly share code, notes, and snippets.

@WebCloud

WebCloud/API_test.md

Created June 23, 2024 19:18
Show Gist options
  • Save WebCloud/60fbfc31f1089b9e779e4a2b8f518a8c to your computer and use it in GitHub Desktop.
Save WebCloud/60fbfc31f1089b9e779e4a2b8f518a8c to your computer and use it in GitHub Desktop.
Download ZIP
Raw
API_test.md
Endpoint Name Endpoint URL (with example query param or example id) cURL (with example token) Result Image from Postman
Fetch Cosplan by date range https://coscalendar-api-3bdc9b15f518.herokuapp.com/cosplansbyDateRange/?startDate=2024-05-26&endDate=2024-07-06 curl --location 'https://coscalendar-api-3bdc9b15f518.herokuapp.com/cosplansbyDateRange/?startDate=2024-05-26&endDate=2024-07-06' --header 'Cookie: my-app-auth=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzE5MTY1ODM3LCJpYXQiOjE3MTkxNjU1MzcsImp0aSI6ImU3YjI5ODEyOGM3ODQ3YWE5ODQ5Y2Q1YTM3Y2Y0ZDhjIiwidXNlcl9pZCI6MX0.yDcj37UnjOsQyWuQf1BLOpHbcmwx8Ci0X1fbM_kXZfg; my-refresh-token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoicmVmcmVzaCIsImV4cCI6MTcxOTI1MTkzNywiaWF0IjoxNzE5MTY1NTM3LCJqdGkiOiIyMzcyMGRlYzhjMTM0ZmE2YTQyZDBhMzc5MWEwMmMzMSIsInVzZXJfaWQiOjF9.qos5VmAXD5UO2yssnid2EzdiRf1KG9iKFIwYNIAr1LY' {"count":2,"next":null,"previous":null,"results":[{"id":6,"cosplayer":"Emma","cosplay":"Mercy","cosplan_task":"Wrap the wings in worbla","due_date":"2024-06-26","cosplan_details":"Time to dig out the heat gun and warm up the worbal!"},{"id":7,"cosplayer":"Emma","cosplay":"Zelda","cosplan_task":"Sewing time","due_date":"2024-07-05","cosplan_details":"Dig out that bag of sewing materials!"}]} image
Fetch expenses for cosplan https://coscalendar-api-3bdc9b15f518.herokuapp.com/expenses/?cosplan_id=6 curl --location 'https://coscalendar-api-3bdc9b15f518.herokuapp.com/expenses/?cosplan_id=6' --header 'Cookie: my-app-auth=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzE5MTY1ODM3LCJpYXQiOjE3MTkxNjU1MzcsImp0aSI6ImU3YjI5ODEyOGM3ODQ3YWE5ODQ5Y2Q1YTM3Y2Y0ZDhjIiwidXNlcl9pZCI6MX0.yDcj37UnjOsQyWuQf1BLOpHbcmwx8Ci0X1fbM_kXZfg; my-refresh-token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoicmVmcmVzaCIsImV4cCI6MTcxOTI1MTkzNywiaWF0IjoxNzE5MTY1NTM3LCJqdGkiOiIyMzcyMGRlYzhjMTM0ZmE2YTQyZDBhMzc5MWEwMmMzMSIsInVzZXJfaWQiOjF9.qos5VmAXD5UO2yssnid2EzdiRf1KG9iKFIwYNIAr1LY' {"count":2,"next":null,"previous":null,"results":[{"id":37,"cosplayer":"Emma","item_name":"gggg","quantity":1,"unit_price":"2.35","product_link":""},{"id":38,"cosplayer":"Emma","item_name":"sdfsdf","quantity":1,"unit_price":"22.00","product_link":""}]} image
Delete expense for cosplan https://coscalendar-api-3bdc9b15f518.herokuapp.com/cosplans/expenses/19/ curl --location --request DELETE 'https://coscalendar-api-3bdc9b15f518.herokuapp.com/cosplans/expenses/19/' --header 'Cookie: my-app-auth=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzE5MTY2ODk3LCJpYXQiOjE3MTkxNjY1OTcsImp0aSI6IjUwYzZjOTNkOTI5ODRmYTZiM2IyMTNiMjdiMzNjMzY5IiwidXNlcl9pZCI6MX0.m87HD87fe7UTTDaDd2FuzfA30FhkWRTYRkkyp8MjNC8; my-refresh-token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoicmVmcmVzaCIsImV4cCI6MTcxOTI1Mjk5NywiaWF0IjoxNzE5MTY2NTk3LCJqdGkiOiIzOWY5ZTgwZmZkMmI0ZTIxYjZhMWM5YTZmODhjZjE3MiIsInVzZXJfaWQiOjF9.YNoonbeiizJ-bSG9Y-4-FOsNemoo-kAjFJs0wDecFaA' empty image
Create expense for cosplan https://coscalendar-api-3bdc9b15f518.herokuapp.com/cosplans/6/expenses/ curl --location 'https://coscalendar-api-3bdc9b15f518.herokuapp.com/cosplans/6/expenses/' --header 'Cookie: my-app-auth=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzE5MTY2Mjc2LCJpYXQiOjE3MTkxNjU5NzYsImp0aSI6ImE1ZmE5MjI2NDIxYzRlY2Y4ZjdlNmE3MzY5YWNjYTY1IiwidXNlcl9pZCI6MX0.4wjBXQj0LK6LW0wh7KLZ8FTDO-IyQKSzNqPchGFrsho; my-refresh-token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoicmVmcmVzaCIsImV4cCI6MTcxOTI1MjM3NiwiaWF0IjoxNzE5MTY1OTc2LCJqdGkiOiI5YWMyMjg1MjIyOGY0NjZlYjYyMGUxYWE1MWYzN2QyYyIsInVzZXJfaWQiOjF9._y9IWszpC-vxr4eHuCXjC22DOtf8wImCtt2XkaHGHLk' --form 'item_name="Something"' --form 'unit_price="13"' --form 'quantity="1"' --form 'cosplan_id="6"' --form 'cosplayer_id="1"' --form 'product_link=""' {"id":41,"cosplayer":"Emma","item_name":"Something","quantity":1,"unit_price":"13.00","product_link":""} image
Edit Cosplan https://coscalendar-api-3bdc9b15f518.herokuapp.com/cosplans/6/ curl --location --request PUT 'https://coscalendar-api-3bdc9b15f518.herokuapp.com/cosplans/6/' --header 'Cookie: my-app-auth=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzE5MTY2NjE4LCJpYXQiOjE3MTkxNjYzMTgsImp0aSI6ImFiYzI1ZDA0ZjA2NTQ4YThiNWVmYjg5MGY2MTVkZTVlIiwidXNlcl9pZCI6MX0.JlMrf-TBvNhwmpucrRoZjeRxjk_TiCy3nYKTrW_siOw; my-refresh-token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoicmVmcmVzaCIsImV4cCI6MTcxOTI1MjcxOCwiaWF0IjoxNzE5MTY2MzE4LCJqdGkiOiI5N2M2NTc1ODRhOTQ0NDdkYmQwZWFjZTVhMjU3M2EyNCIsInVzZXJfaWQiOjF9.TZ9IHvL0ADQJONcaso-hD84ZhulaQJBxbCeU9nW66Qw' --header 'Content-Type: application/json' --data '{"id":6,"cosplayer":"Emma","cosplay":"Mercyadadde","cosplan_task":"Wrap the wings in worbla","due_date":"2024-06-26","cosplan_details":"Time to dig out the heat gun and warm up the worbal!"}' {"id":6,"cosplayer":"Emma","cosplay":"Mercyadadde","cosplan_task":"Wrap the wings in worbla","due_date":"2024-06-26","cosplan_details":"Time to dig out the heat gun and warm up the worbal!"} image
Delete Cosplan https://coscalendar-api-3bdc9b15f518.herokuapp.com/cosplans/6/ curl --location --request DELETE 'https://coscalendar-api-3bdc9b15f518.herokuapp.com/cosplans/6/' --header 'Cookie: my-app-auth=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzE5MTY2NjE4LCJpYXQiOjE3MTkxNjYzMTgsImp0aSI6ImFiYzI1ZDA0ZjA2NTQ4YThiNWVmYjg5MGY2MTVkZTVlIiwidXNlcl9pZCI6MX0.JlMrf-TBvNhwmpucrRoZjeRxjk_TiCy3nYKTrW_siOw; my-refresh-token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoicmVmcmVzaCIsImV4cCI6MTcxOTI1MjcxOCwiaWF0IjoxNzE5MTY2MzE4LCJqdGkiOiI5N2M2NTc1ODRhOTQ0NDdkYmQwZWFjZTVhMjU3M2EyNCIsInVzZXJfaWQiOjF9.TZ9IHvL0ADQJONcaso-hD84ZhulaQJBxbCeU9nW66Qw' empty image
Create Cosplan https://coscalendar-api-3bdc9b15f518.herokuapp.com/cosplans/ curl --location 'https://coscalendar-api-3bdc9b15f518.herokuapp.com/cosplans/' --header 'Cookie: my-app-auth=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzE5MTY2NjE4LCJpYXQiOjE3MTkxNjYzMTgsImp0aSI6ImFiYzI1ZDA0ZjA2NTQ4YThiNWVmYjg5MGY2MTVkZTVlIiwidXNlcl9pZCI6MX0.JlMrf-TBvNhwmpucrRoZjeRxjk_TiCy3nYKTrW_siOw; my-refresh-token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoicmVmcmVzaCIsImV4cCI6MTcxOTI1MjcxOCwiaWF0IjoxNzE5MTY2MzE4LCJqdGkiOiI5N2M2NTc1ODRhOTQ0NDdkYmQwZWFjZTVhMjU3M2EyNCIsInVzZXJfaWQiOjF9.TZ9IHvL0ADQJONcaso-hD84ZhulaQJBxbCeU9nW66Qw' --header 'Content-Type: application/json' --data '{"cosplayer":"Emma","cosplay":"Mercyadadde","cosplan_task":"Wrap the wings in worbla","due_date":"2024-06-26","cosplan_details":"Time to dig out the heat gun and warm up the worbal!"}' {"id":21,"cosplayer":"Emma","cosplay":"Mercyadadde","cosplan_task":"Wrap the wings in worbla","due_date":"2024-06-26","cosplan_details":"Time to dig out the heat gun and warm up the worbal!"} image
Edit user profile https://coscalendar-api-3bdc9b15f518.herokuapp.com/user_profiles/1/ curl --location --request PUT 'https://coscalendar-api-3bdc9b15f518.herokuapp.com/user_profiles/1/' --header 'Cookie: my-app-auth=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzE5MTY2ODk3LCJpYXQiOjE3MTkxNjY1OTcsImp0aSI6IjUwYzZjOTNkOTI5ODRmYTZiM2IyMTNiMjdiMzNjMzY5IiwidXNlcl9pZCI6MX0.m87HD87fe7UTTDaDd2FuzfA30FhkWRTYRkkyp8MjNC8; my-refresh-token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoicmVmcmVzaCIsImV4cCI6MTcxOTI1Mjk5NywiaWF0IjoxNzE5MTY2NTk3LCJqdGkiOiIzOWY5ZTgwZmZkMmI0ZTIxYjZhMWM5YTZmODhjZjE3MiIsInVzZXJfaWQiOjF9.YNoonbeiizJ-bSG9Y-4-FOsNemoo-kAjFJs0wDecFaA' --header 'Content-Type: application/json' --data '{"id":1,"cosplayer":"Emma","is_cosplayer":true,"name":"","user_bio":"Very tired nerd that needs a break - edit test ❤️","fave_cosplay":"Bo Katandeededea","next_convention":"ComicCon Winter 2024"}' {"id":1,"cosplayer":"Emma","is_cosplayer":true,"name":"","user_bio":"Very tired nerd that needs a break - edit test ❤️","fave_cosplay":"Bo Katandeededea","next_convention":"ComicCon Winter 2024"} image
Example of authentication token expired (Edit user profile) https://coscalendar-api-3bdc9b15f518.herokuapp.com/user_profiles/1/ curl --location --request PUT 'https://coscalendar-api-3bdc9b15f518.herokuapp.com/user_profiles/1/' --header 'Cookie: my-app-auth=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzE5MTY2ODk3LCJpYXQiOjE3MTkxNjY1OTcsImp0aSI6IjUwYzZjOTNkOTI5ODRmYTZiM2IyMTNiMjdiMzNjMzY5IiwidXNlcl9pZCI6MX0.m87HD87fe7UTTDaDd2FuzfA30FhkWRTYRkkyp8MjNC8; my-refresh-token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoicmVmcmVzaCIsImV4cCI6MTcxOTI1Mjk5NywiaWF0IjoxNzE5MTY2NTk3LCJqdGkiOiIzOWY5ZTgwZmZkMmI0ZTIxYjZhMWM5YTZmODhjZjE3MiIsInVzZXJfaWQiOjF9.YNoonbeiizJ-bSG9Y-4-FOsNemoo-kAjFJs0wDecFaA' --header 'Content-Type: application/json' --data '{"id":1,"cosplayer":"Emma","is_cosplayer":true,"name":"","user_bio":"Very tired nerd that needs a break - edit test ❤️","fave_cosplay":"Bo Katandeededea","next_convention":"ComicCon Winter 2024"}' {"detail":"Given token not valid for any token type","code":"token_not_valid","messages":[{"token_class":"AccessToken","token_type":"access","message":"Token is invalid or expired"}]} image
Example of authentication token not provided (Edit user profile) https://coscalendar-api-3bdc9b15f518.herokuapp.com/user_profiles/1/ curl --location --request PUT 'https://coscalendar-api-3bdc9b15f518.herokuapp.com/user_profiles/1/' --header 'Content-Type: application/json' --data '{"id":1,"cosplayer":"Emma","is_cosplayer":true,"name":"","user_bio":"Very tired nerd that needs a break - edit test ❤️","fave_cosplay":"Bo Katandeededea","next_convention":"ComicCon Winter 2024"}' {"detail":"Authentication credentials were not provided."} image
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment