lib4ap 0.1.3

API client for 4ALLPORTAL
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

#![deny(missing_docs)]
#![crate_name = "lib4ap"]
//! [![crate-badge]][crate-link] [![docs-badge]][docs-link]
//! 
//! [crate-badge]: https://img.shields.io/crates/v/lib4ap.svg
//! [crate-link]: https://crates.io/crates/lib4ap
//! [docs-badge]: https://docs.rs/lib4ap/badge.svg
//! [docs-link]: https://docs.rs/lib4ap
//! 
//! This crate provides a client for the 4ALLPORTAL API.
//! In order to be able to use this client, you will need
//! a valid API key for a 4ALLPORTAL instance. 
//! Username and password authentication is not supported 
//! and will not be implemented.
//! 
//! **NOTE:** So far, only objects are implemented with more support coming in the future.
//! 
//! # Getting started
//! 
//! ```rust
//! use lib4ap::ScopedClient;
//! 
//! #[tokio::main]
//! async fn main() {
//!     let pim_url = std::env::var("PIM_URL").expect("PIM_URL must be set");
//!     let api_key = std::env::var("API_KEY").expect("API_KEY must be set");
//!     let module = std::env::var("MODULE").expect("MODULE must be set");
//! 
//!     let product_client = ScopedClient(&pim_url, &api_key, &module);
//!     let products = product_client.get_all_objects(vec!["id", "name"], None, Some(25));
//! }
//! ```

#[macro_use]
extern crate custom_error;

mod models;

/// Contains the API client and methods for interacting with the API.
pub mod client;

pub use client::ScopedClient;
pub use models::*;