The Freddy's Artisanal Halloween Candy Shop API provides a digital interface for accessing the shop's extensive features and data, including user authentication, dashboard analytics, and order management. This API, designed with OpenAPI 3.0.1 specifications, enables developers to seamlessly integrate with Freddy's online platform, facilitating operations like login authentication, token refreshment, dashboard data retrieval, and comprehensive orders handling.
\nWith endpoints meticulously documented for clarity and ease of use, this API is the gateway to automating and enhancing the ecommerce capabilities of Freddy's Artisanal Halloween Candy Shop, making it an essential tool for developers aiming to interact with the shop's system programmatically.
\nContact Support:
\nUse the Login endpoint to generate an access_token and a refresh_token for authorization of other endpoints.
The access_tokens are valid for 15 minutes. You can use the refresh_token (valid for 30 days) generated earlier to renew the access_token. See POST Refresh token for more details.
Note: These are JWT tokens. (JSON web tokens)
\n
Enter your username and password in the request body as a JSON object to generate the tokens.
To avoid hassles with wrong credentials, ensure to enter accurate username and password as JSON object. Otherwise, the server will throw an error.
Method: POST
Endpoint: https://freddy.codesubmit.io/login
Request Header: Content_Type:application/json. (login endpoint only accepts application/json)
\n
\n
\n
\n
\n
The browser (or proxy) sent a request that this server could not understand.
"},{"id":"36400ebb-0879-407d-a334-8b7a40d4244d","name":"Bad Credentials","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"username\": \"sampliman\",\n \"password\": \"samplipassword\"\n}"},"url":"https://freddy.codesubmit.io/login"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":"{\r\n \"msg\":\"Bad Credentials\"\r\n}"}],"_postman_id":"cd1806b9-16cd-46d1-87f5-e4b477035837"},{"name":"Refresh Token","id":"f351b580-268e-4b88-93cc-a487b20904ab","request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Use the refresh endpoint to request a new access_token using the active refresh_token generated earlier.
The refresh_token, once generated is valid for 30 days
To refresh the access_token provide an active refresh_token in the authorization header.
Method: POST
Endpoint: https://freddy.codesubmit.io/refresh
Request Header: Authorization: Bearer <refresh_token>
\n
\n
\n
\n
The browser (or proxy) sent a request that this server could not understand.
"},{"id":"795a4b09-832a-4b81-8a6d-9eb4078a8259","name":"Missing Authorization Header","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerUse the dashboard endpoint to retrieve the entire dashboard data. This includes the data of revenue earned and units sold for the best sellers, sales over a week, and sales over a year.
\nTo retrieve the dashboard data, provide the access_token in the authorization header.
Method: GET
Endpoint: https://freddy.codesubmit.io/dashboard
Request Header: Authorization: Bearer <access_token>
\n
\n
\n
The browser (or proxy) sent a request that this server could not understand.
"},{"id":"1b8d6a02-d457-45c4-bb7b-72911ae623d1","name":"Token Expired","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerUse the Orders endpoint to retrieve all the Orders Data. This includes the data of:
\nTo retrieve the Orders data, provide the access_token in the authorization header.
Method: GET
Endpoint: https://freddy.codesubmit.io/orders
Request Header: Authorization: Bearer <access_token>
\n
\n
\n
Pagination allows to retrieve the orders data of the desired page. Specify the page number to get the details of that particular page.
\nTotal number of retrieved pages = Total number of orders / page size\n\n
The q query parameter allows to filter the Orders data only for the following elements:
surname or name\n
The browser (or proxy) sent a request that this server could not understand.
"},{"id":"c7ab4f33-7f33-4b6d-a916-728097c9d528","name":"Token Expired","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer