Difference between revisions of "Client API"
| Line 1: | Line 1: | ||
| − | == Gage Status and Metadata == | + | ==Gage Status and Metadata== |
| − | === Methods === | + | ===Methods=== |
| − | ==== | + | ====APIGetLocationInfo==== |
| − | + | ====GetMetagages==== | |
| − | + | A "Metagage" is a list of gages that we sometimes show aggregated data for. The primary use is for the "Sum of the 3 forks" gage on the Forecasts page, which is the sum of readings and forecasts for three separate gages at the three forks of the river. | |
| − | + | Endpoint: GET <code>floodzilla.com/api/client/GetMetagages</code> | |
| + | ====GetLocations==== | ||
| + | Deprecated. | ||
| + | ====GetGageReadingsUTC==== | ||
Deprecated. | Deprecated. | ||
| − | |||
| − | == Authentication == | + | ==Authentication== |
Floodzilla has its own AuthZ/AuthN API; it does not use a third party service like Auth0. The primary reason is integration with | Floodzilla has its own AuthZ/AuthN API; it does not use a third party service like Auth0. The primary reason is integration with | ||
| Line 22: | Line 24: | ||
[Full documentation will be added eventually] | [Full documentation will be added eventually] | ||
| − | === Methods === | + | ===Methods=== |
| − | ==== Authenticate ==== | + | ====Authenticate==== |
| − | ==== Reauthenticate ==== | + | ====Reauthenticate==== |
| − | ==== CreateAccount ==== | + | ====CreateAccount==== |
| − | ==== APIForgotPassword ==== | + | ====APIForgotPassword==== |
| − | ==== APISetPassword ==== | + | ====APISetPassword==== |
| − | ==== APICreatePassword ==== | + | ====APICreatePassword==== |
| − | ==== APIResetPassword ==== | + | ====APIResetPassword==== |
| − | ==== SendVerificationEmail ==== | + | ====SendVerificationEmail==== |
| − | ==== VerifyEmail ==== | + | ====VerifyEmail==== |
| − | ==== SendPhoneVerificationSMS ==== | + | ====SendPhoneVerificationSMS==== |
| − | ==== VerifyPhone ==== | + | ====VerifyPhone==== |
| − | ==== UpdateAccount ==== | + | ====UpdateAccount==== |
| − | ==== AuthenticateWithGoogle ==== | + | ====AuthenticateWithGoogle==== |
| − | == Subscription == | + | ==Subscription== |
The Subscription API allows clients to subscribe to various kinds of notifications (currently just email and SMS) for gages and forecast data. | The Subscription API allows clients to subscribe to various kinds of notifications (currently just email and SMS) for gages and forecast data. | ||
| − | === Methods === | + | ===Methods=== |
[Documentation to come] | [Documentation to come] | ||
Revision as of 18:31, 9 March 2023
Gage Status and Metadata
Methods
APIGetLocationInfo
GetMetagages
A "Metagage" is a list of gages that we sometimes show aggregated data for. The primary use is for the "Sum of the 3 forks" gage on the Forecasts page, which is the sum of readings and forecasts for three separate gages at the three forks of the river.
Endpoint: GET floodzilla.com/api/client/GetMetagages
GetLocations
Deprecated.
GetGageReadingsUTC
Deprecated.
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]
