Crate rippling_base_api

A fully generated & opinionated API client for the Rippling Base API.

API Details

Using Rippling’s API requires either an API key or an access token retrieved from an OAuth exchange. Each is tied to a single Rippling Company.

If you are a partner building an integration to Rippling,you can use Rippling’s Installation Guide to learn how to retrieve an access token to start using Rippling APIs.

If you are a customer, you can go here to learn create your API keys to start using Rippling APIs.

Using the Interactive Documentation

Rippling’s Documentation Portal allows you to test the API endpoints directly within the documentation. To do so, provide your API key or Access Token as a header parameter with the form Authorization Bearer: Bearer.

API Terms of Service

Contact

name	email
Rippling Support	support@rippling.com

License

name
MIT

Client Details

The documentation for the crate is generated along with the code to make this library easy to use.

To install the library, add the following to your Cargo.toml file.

[dependencies]
rippling-base-api = "0.1.0"

Basic example

Typical use will require intializing a Client. This requires a user agent string and set of credentials.

use rippling_base_api::Client;

let client = Client::new(String::from("api-key"));

Alternatively, the library can search for most of the variables required for the client in the environment:

• RIPPLING_BASE_API_TOKEN

And then you can create a client from the environment.

use rippling_base_api::Client;

let client = Client::new_from_env();

Modules

• application_management
• ats
• companies
• current_user
• employees
• groups
• leaves
• saml
• types
  This module contains the generated types for the library.
• utils

Structs

• Client
  Entrypoint for interacting with the API client.
• RequestBuilder
  A request builder.