Add REST API support with backward-compatible auto detection#454
Open
espipj wants to merge 12 commits intoiMicknl:mainfrom
Open
Add REST API support with backward-compatible auto detection#454espipj wants to merge 12 commits intoiMicknl:mainfrom
espipj wants to merge 12 commits intoiMicknl:mainfrom
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds support for newer Sagemcom firmware that exposes
/api/v1/*endpoints, while preserving compatibility with legacy/cgi/json-reqfirmware.What Changed
ApiModeenum:ApiMode.AUTO(default)ApiMode.LEGACYApiMode.RESTSagemcomClientwithapi_modeparameter.login():LEGACY: force legacy flowREST: force REST flowAUTO: try legacy first, fallback to REST when legacy endpoint appears unavailable.login()viaPOST /api/v1/login(form-encoded)logout()viaPOST /api/v1/logoutget_device_info()viaGET /api/v1/deviceget_hosts()viaGET /api/v1/homeNotImplementedErrorin REST mode.Backward Compatibility
AUTO, so legacy users do not need to change code.Tests
AUTOfallback to REST on legacy 503 HTML response.get_hosts()parsing (wireless + ethernet devices).Documentation
ApiModeusage in quickstart