Overview¶

This example shows how to log in to Mat3ra RESTFul API via Login endpoint and generate API authentication parameters. Note that it is also possible to generate an API token manually via platform web UI as described in the project README.

Execution¶

NOTE: In order to run this example, an active Mat3ra.com account is required.

Set Parameters¶

• USERNAME: Your Mat3ra account username.

• PASSWORD: Your Mat3ra account password.

In [ ]:

# @title Authorization Form
USERNAME = "YOUR_USERNAME"  # @param {type:"string"}

# avoid storing password in plaintext
from getpass import getpass

PASSWORD = getpass("Please enter password: ")

import os

if "COLAB_JUPYTER_IP" in os.environ:
    !GIT_BRANCH="dev"; export GIT_BRANCH; curl -s "https://raw.githubusercontent.com/Exabyte-io/api-examples/${GIT_BRANCH}/scripts/env.sh" | bash

# @title Authorization Form USERNAME = "YOUR_USERNAME" # @param {type:"string"} # avoid storing password in plaintext from getpass import getpass PASSWORD = getpass("Please enter password: ") import os if "COLAB_JUPYTER_IP" in os.environ: !GIT_BRANCH="dev"; export GIT_BRANCH; curl -s "https://raw.githubusercontent.com/Exabyte-io/api-examples/${GIT_BRANCH}/scripts/env.sh" | bash

Import packages¶

In [ ]:

from utils.settings import HOST, PORT, VERSION, SECURE
from utils.generic import display_JSON

from exabyte_api_client.endpoints.login import LoginEndpoint

from utils.settings import HOST, PORT, VERSION, SECURE from utils.generic import display_JSON from exabyte_api_client.endpoints.login import LoginEndpoint

Initialize the endpoint¶

In [ ]:

endpoint = LoginEndpoint(HOST, PORT, USERNAME, PASSWORD, VERSION, SECURE)
auth_params = endpoint.login()

endpoint = LoginEndpoint(HOST, PORT, USERNAME, PASSWORD, VERSION, SECURE) auth_params = endpoint.login()

Print authentication parameters¶

Print the authentication parameters in pretty JSON below. Update settings with this parameters to be able to run other examples.

In [ ]:

display_JSON(auth_params)

display_JSON(auth_params)