Crate briteverify_rs
source ·Expand description
briteverify-rs
briteverify-rs
provides a type-safe, ergonomic client for
the BriteVerify API based on
the popular reqwest
HTTP client library.
It aims to provide a simple and convenient way to interact with the BriteVerify API from Rust. It tries to be easy to use, with a focus on allowing devs to quickly get up and running with the API.
The BriteVerifyClient
is asynchronous. It
does not currently support synchronous usage at all.
Features
briteverify-rs
provides:
- Fully documented reqwest-based client for the BriteVerify API
- Type-safe requests and responses w/ serde support
- Support for all¹ single-transaction and bulk² BriteVerify API endpoints
- Easy-to-use API that follows Rust conventions
- 1:
briteverify-rs
makes a best-effort attempt to stay current with the BriteVerify API, but is ultimately maintained independently. Best-effort means that no guarantees are made, but PRs are always accepted. - 2:
briteverify-rs
currently implements support for thev3
bulk endpoints, with no plans to add support for legacy or deprecated endpoints (namely thev2
endpoints in this case).
Basic Usage
let response: AccountCreditBalance = BriteVerifyClient::new("YOUR API KEY HERE")?
.get_account_balance()
.await?;
println!("{response:#?}");
Re-exports
pub use client::BriteVerifyClient;
pub use client::BriteVerifyClientBuilder;
Modules
- BriteVerify API Client
- Errors
- Type Definitions