Crate lib4ap

Source
Expand description

crate-badge docs-badge

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

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));
}

Re-exports§

pub use client::ScopedClient;

Modules§

client
Contains the API client and methods for interacting with the API.

Structs§

CreateUpdateObject
An object to be created or updated
MetricUnit
A metric unit of a field
ModuleField
A field of a module
ModuleObject
A module returned by the modules API
Object
A single object returned by the objects API
ObjectList
A list of objects returned by the objects API
SimpleValue
A simple value container

Enums§

ComplexValue
A complex value container