Api Doc?

[micio86dev]

Hi, where is the documentation of Yazio Api?
Your work it's ok, I get my user info from Api.

Tnx

[saganos]

My apologies for the very late response - there is no documentation at all - it was briefly explained in
why section

[WaldemarEnns]

We could generate a swagger documentation for this. I did it with some help of ChatGPT. You can paste it here:
https://editor-next.swagger.io/

And at least try out the login. For the actual endpoints, you need a local client (like this repo) since it requires HTTPS with CORS settings (same origin) to function correctly. So expect CORS errors when using the swagger editor to play around.

Screenshot:

{
    "swagger": "2.0",
    "info": {
        "description": "This is a sample server for Yazio API.",
        "version": "1.0.0",
        "title": "Yazio API",
        "termsOfService": "http://swagger.io/terms/",
        "contact": {
            "email": "apiteam@swagger.io"
        }
    },
    "host": "api.yazio.com",
    "basePath": "/v1",
    "tags": [
        {
            "name": "auth",
            "description": "Authentication related endpoints"
        },
        {
            "name": "meals",
            "description": "Meal management endpoints"
        },
        {
            "name": "nutrients",
            "description": "Nutrient information endpoints"
        }
    ],
    "schemes": [
        "https"
    ],
    "paths": {
        "/login": {
            "post": {
                "tags": [
                    "auth"
                ],
                "summary": "User login",
                "description": "Login to Yazio App with username and password using OAuth2.",
                "parameters": [
                    {
                        "name": "body",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/Login"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Successful login",
                        "schema": {
                            "$ref": "#/definitions/AuthResponse"
                        }
                    }
                }
            }
        },
        "/token_refresh": {
            "post": {
                "tags": [
                    "auth"
                ],
                "summary": "Refresh token",
                "description": "Refreshes the authentication token.",
                "parameters": [
                    {
                        "name": "body",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/TokenRefresh"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Token refreshed",
                        "schema": {
                            "$ref": "#/definitions/AuthResponse"
                        }
                    }
                }
            }
        },
        "/user_info": {
            "get": {
                "tags": [
                    "auth"
                ],
                "summary": "Get user info",
                "description": "Retrieves user information.",
                "responses": {
                    "200": {
                        "description": "Successful retrieval",
                        "schema": {
                            "$ref": "#/definitions/UserInfo"
                        }
                    }
                }
            }
        },
        "/share_meal": {
            "post": {
                "tags": [
                    "meals"
                ],
                "summary": "Share meal",
                "description": "Share saved meal with other users.",
                "parameters": [
                    {
                        "name": "body",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/ShareMeal"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Meal shared",
                        "schema": {
                            "$ref": "#/definitions/ShareMealResponse"
                        }
                    }
                }
            }
        },
        "/log_meal": {
            "post": {
                "tags": [
                    "meals"
                ],
                "summary": "Log a meal",
                "description": "Log a meal for the user.",
                "parameters": [
                    {
                        "name": "body",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/LogMeal"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Meal logged",
                        "schema": {
                            "$ref": "#/definitions/LogMealResponse"
                        }
                    }
                }
            }
        },
        "/get_meals": {
            "get": {
                "tags": [
                    "meals"
                ],
                "summary": "Get meals",
                "description": "Retrieve meals logged by the user.",
                "responses": {
                    "200": {
                        "description": "Successful retrieval",
                        "schema": {
                            "$ref": "#/definitions/Meals"
                        }
                    }
                }
            }
        },
        "/nutrients_info": {
            "get": {
                "tags": [
                    "nutrients"
                ],
                "summary": "Get nutrient information",
                "description": "Get detailed nutrient information.",
                "responses": {
                    "200": {
                        "description": "Successful retrieval",
                        "schema": {
                            "$ref": "#/definitions/NutrientsInfo"
                        }
                    }
                }
            }
        }
    },
    "definitions": {
        "Login": {
            "type": "object",
            "required": [
                "username",
                "password"
            ],
            "properties": {
                "username": {
                    "type": "string"
                },
                "password": {
                    "type": "string"
                }
            }
        },
        "AuthResponse": {
            "type": "object",
            "properties": {
                "token": {
                    "type": "string"
                }
            }
        },
        "TokenRefresh": {
            "type": "object",
            "required": [
                "token"
            ],
            "properties": {
                "token": {
                    "type": "string"
                }
            }
        },
        "UserInfo": {
            "type": "object",
            "properties": {
                "id": {
                    "type": "string"
                },
                "username": {
                    "type": "string"
                },
                "email": {
                    "type": "string"
                }
            }
        },
        "ShareMeal": {
            "type": "object",
            "required": [
                "mealId",
                "recipientId"
            ],
            "properties": {
                "mealId": {
                    "type": "string"
                },
                "recipientId": {
                    "type": "string"
                }
            }
        },
        "ShareMealResponse": {
            "type": "object",
            "properties": {
                "status": {
                    "type": "string"
                }
            }
        },
        "LogMeal": {
            "type": "object",
            "required": [
                "mealDetails"
            ],
            "properties": {
                "mealDetails": {
                    "type": "string"
                }
            }
        },
        "LogMealResponse": {
            "type": "object",
            "properties": {
                "status": {
                    "type": "string"
                }
            }
        },
        "Meals": {
            "type": "object",
            "properties": {
                "meals": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/Meal"
                    }
                }
            }
        },
        "Meal": {
            "type": "object",
            "properties": {
                "id": {
                    "type": "string"
                },
                "details": {
                    "type": "string"
                }
            }
        },
        "NutrientsInfo": {
            "type": "object",
            "properties": {
                "nutrients": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/Nutrient"
                    }
                }
            }
        },
        "Nutrient": {
            "type": "object",
            "properties": {
                "name": {
                    "type": "string"
                },
                "amount": {
                    "type": "string"
                }
            }
        }
    },
    "securityDefinitions": {
        "oauth2": {
            "type": "oauth2",
            "flow": "password",
            "tokenUrl": "https://yzapi.yazio.com/v12/oauth/token",
            "scopes": {}
        }
    },
    "security": [
        {
            "oauth2": []
        }
    ]
}

This already works for me when using the Authorize button to log in against yazio and retrieve a token. Try it out yourself.

Note: You need to use the cliend_it and client_secret that is specified in this repository: https://github.com/saganos/yazio_public_api/blob/master/examples/login.js

Note: Is it correct that you want the client_id and client_secret being public in this repo? Also: Where did you get these information from @saganos ?

[WaldemarEnns]

Added a PR for the docs:

#2

[saganos]

It was a long time ago but probably by just checking the requests from android client, similar to https://medium.com/@roy2477/decrypting-android-app-ssl-traffic-c480e2143743. AFAIR with mitmweb (mitmproxy) and real android device.

[WaldemarEnns]

It was a long time ago but probably by just checking the requests from android client, similar to https://medium.com/@roy2477/decrypting-android-app-ssl-traffic-c480e2143743. AFAIR with mitmweb (mitmproxy) and real android device.

I see, thank you very much dor the reference. I noticed that my 'swagger.json' file might contain some wrong routes/URLs. I will fine-tune them and provide an enhanced swagger config file.

[WaldemarEnns]

@micio86dev can we close this issue?

[micio86dev]

Yes, many thanks Il giorno sab 15 giu 2024 alle ore 22:59 Waldemar Enns < ***@***.***> ha scritto:

…

@micio86dev <https://github.com/micio86dev> can we close this issue? — Reply to this email directly, view it on GitHub <#1 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ALXK3NOGKS3QGRQTOVBLVADZHS2LXAVCNFSM6AAAAABI6IOUVGVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCNZQHEZTONRWGI> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[ewoks]

@WaldemarEnns can you confirm if this is still up-to-date and you regulary use it? Thanks

[freubreu88-byte]

@WaldemarEnns

[WaldemarEnns]

Hey there! Sorry for the delay. Personally I have not used this repo for a while. Are there any issues you encounteted?

[RubenTerzian]

@WaldemarEnns I'm not sure if it's a 'me problem' or not. But looks like the login endpoint no longer exists there. It returns 410 status code

• some base explanation from gpt:

The client_id and client_secret from the saganos/yazio_public_api repository no longer work for login.
The reason is that the unofficial API endpoint v5/oauth/token has been removed by Yazio.
This means:
Even if you provide the correct email and password, the request will fail.
The server returns HTTP 410 (Gone), which indicates that the resource/endpoint is no longer available.
So the old unofficial API can’t be used anymore to get an auth token.