Struct geeny_api::ConnectApi

pub struct ConnectApi(_);

Interface for Geeny Connect APIs

ConnectApi is an interface for interacting with the Geeny Connect API. The full specification of these APIs may be found in the API Specification.

Methods

impl ConnectApi

fn new(host: String, port: u16) -> Self

Create a new Connect API handle

Example

use geeny_api::ConnectApi;

let api = ConnectApi::new("https://connect.geeny.io".into(), 443);

fn registration(&self, req: &RegistrationRequest) -> Result<AuthLoginResponse>

Register a new account and obtain an API token

If the response was successful, Ok(AuthLoginResponse) is returned. If a network or server error occurred, or if the parameters were incorrect, an Err is returned.

Example

extern crate geeny_api;
use geeny_api::ConnectApi;
use geeny_api::models::*;

fn main() {
    let api = ConnectApi::default();

    let new_user = RegistrationRequest {
        email: "demo@email.com".into(),
        first_name: "Demo".into(),
        last_name: "User".into(),
        password: "S3cureP@ssword!".into(),
        is_developer: true,
    };

    let response = api.registration(&new_user).unwrap();
    println!("token: {}", response.token);
}

fn delete_user(&self, token: &str) -> Result<()>

fn login(&self, req: &AuthLoginRequest) -> Result<AuthLoginResponse>

Perform a Basic Auth login and obtain an API token

If the response was successful, Ok(AuthLoginResponse) is returned. If a network or server error occurred, or if the credentials were incorrect, an Err is returned.

Example

extern crate geeny_api;
use geeny_api::ConnectApi;
use geeny_api::models::*;

fn main() {
    let api = ConnectApi::default();

    let log_req = AuthLoginRequest {
        email: "demo@email.com".into(),
        password: "S3cureP@ssword!".into(),
    };

    let response = api.login(&log_req).unwrap();
    println!("token: {}", response.token);
}

fn check_token(&self, req: &AuthLoginResponse) -> Result<()>

Check the validity of an API token

If the response was successful, Ok(()) is returned. If a network or server error occurred, or if the token is invalid, an Err is returned.

Example

extern crate geeny_api;
use geeny_api::ConnectApi;
use geeny_api::models::*;

fn main() {
    let api = ConnectApi::default();

    // first, obtain a token
    let log_req = AuthLoginRequest {
        email: "demo@email.com".into(),
        password: "S3cureP@ssword!".into(),
    };

    let response = api.login(&log_req).unwrap();

    // then, verify the token
    api.check_token(&response).unwrap();
}

fn refresh_token(&self, req: &AuthLoginResponse) -> Result<AuthLoginResponse>

Refresh an API token

If the response was successful, Ok(AuthLoginResponse) is returned. If a network or server error occurred, or if the token is not refreshable, an Err is returned.

The token returned should be used for all further API requests, and the original token should be discarded on successful refresh.

Example

extern crate geeny_api;
use geeny_api::ConnectApi;
use geeny_api::models::*;

fn main() {
    let api = ConnectApi::default();

    // first, obtain a token
    let log_req = AuthLoginRequest {
        email: "demo@email.com".into(),
        password: "S3cureP@ssword!".into(),
    };
    let response = api.login(&log_req).unwrap();
    println!("1st Token: {}", response.token);

    // then, refresh the token
    let new_response = api.refresh_token(&response).unwrap();
    println!("2nd Token: {}", new_response.token);
}

Trait Implementations

impl Debug for ConnectApi

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Clone for ConnectApi

fn clone(&self) -> ConnectApi

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for ConnectApi

fn default() -> Self

Create a ConnectApi handle for the Production Connect Service

Example

use geeny_api::ConnectApi;

let api = ConnectApi::default();