Difference between revisions of "Client API"
Jump to navigation
Jump to search
(Created page with "== Floodzilla Client API ==") |
|||
| Line 1: | Line 1: | ||
| − | == Floodzilla | + | == Gage Status and Metadata == |
| + | |||
| + | === Methods === | ||
| + | |||
| + | ==== GetLocations ==== | ||
| + | |||
| + | Deprecated. | ||
| + | |||
| + | ==== GetMetagages ==== | ||
| + | |||
| + | ==== GetGageReadingsUTC ==== | ||
| + | |||
| + | Deprecated. | ||
| + | |||
| + | ==== APIGetLocationInfo ==== | ||
| + | |||
| + | == Authentication == | ||
| + | |||
| + | Floodzilla has its own AuthZ/AuthN API; it does not use a third party service like Auth0. The primary reason is integration with | ||
| + | ASP.NET's built-in authentication and identity services, which the existing back end and admin tools use. | ||
| + | |||
| + | [Full documentation will be added eventually] | ||
| + | |||
| + | === Methods === | ||
| + | |||
| + | ==== Authenticate ==== | ||
| + | |||
| + | ==== Reauthenticate ==== | ||
| + | |||
| + | ==== CreateAccount ==== | ||
| + | |||
| + | ==== APIForgotPassword ==== | ||
| + | |||
| + | ==== APISetPassword ==== | ||
| + | |||
| + | ==== APICreatePassword ==== | ||
| + | |||
| + | ==== APIResetPassword ==== | ||
| + | |||
| + | ==== SendVerificationEmail ==== | ||
| + | |||
| + | ==== VerifyEmail ==== | ||
| + | |||
| + | ==== SendPhoneVerificationSMS ==== | ||
| + | |||
| + | ==== VerifyPhone ==== | ||
| + | |||
| + | ==== UpdateAccount ==== | ||
| + | |||
| + | ==== AuthenticateWithGoogle ==== | ||
| + | |||
| + | == Subscription == | ||
| + | |||
| + | The Subscription API allows clients to subscribe to various kinds of notifications (currently just email and SMS) for gages and forecast data. | ||
| + | |||
| + | === Methods === | ||
| + | |||
| + | [Documentation to come] | ||
Revision as of 18:08, 9 March 2023
Gage Status and Metadata
Methods
GetLocations
Deprecated.
GetMetagages
GetGageReadingsUTC
Deprecated.
APIGetLocationInfo
Authentication
Floodzilla has its own AuthZ/AuthN API; it does not use a third party service like Auth0. The primary reason is integration with ASP.NET's built-in authentication and identity services, which the existing back end and admin tools use.
[Full documentation will be added eventually]
Methods
Authenticate
Reauthenticate
CreateAccount
APIForgotPassword
APISetPassword
APICreatePassword
APIResetPassword
SendVerificationEmail
VerifyEmail
SendPhoneVerificationSMS
VerifyPhone
UpdateAccount
AuthenticateWithGoogle
Subscription
The Subscription API allows clients to subscribe to various kinds of notifications (currently just email and SMS) for gages and forecast data.
Methods
[Documentation to come]
