This library crate can be used for calling functions on the Transip Api endpoint. Only part of the api is implemented. The main reason for writing this library is the ability to CRUD dns records for a particular domain. This functionality can be used to respond to DNS01 challenges from the Let's Encrypt servers. This type of challenge is needed to get wildcard certificates.

Usage

cargo add transip

Example

use transip::{configuration_from_environment, Client, api::general::GeneralApi};

fn main() {
    let mut client = configuration_from_environment()
        .and_then(Client::try_from)
        .expect("No cliënt");

    let pong = client.api_test().unwrap();
    assert_eq!(pong.as_str(), "pong");
}

Environment variables

The following environment variables should be set!.

TRANSIP_API_USERNAME

This is the username used in authentication

Example

export TRANSIP_API_USERNAME=paulusminus

TRANSIP_API_PRIVATE_KEY

This is the name of the file that holds the pem encoded private key used in authentication

Example

export TRANSIP_API_PRIVATE_KEY=/etc/transip/private.pem

TRANSIP_API_READONLY

Can be 'true' or 'false'. If you wan't to prevent accidental modifications set this to 'true'.

Example

export TRANSIP_API_READONLY=false

TRANSIP_API_WHITELISTED_ONLY

Can be 'true' or 'false'.

TRANSIP_API_TOKEN_EXPIRATION

Authentication means receiving a token. The interval in which the received will expired can be controlled.

Example 1

export TRANSIP_API_TOKEN_EXPIRATION=5 minutes

Example 2

export TRANSIP_API_TOKEN_EXPIRATION=55 seconds

Example 3

export TRANSIP_API_TOKEN_EXPIRATION=1 hour