A client library for accessing pymetrics Assessment API
Project description
pymetrics-assessment-api-client
A client library for accessing pymetrics Assessment API
Installation
pip install pymetrics-assessment-api-client
Base URLs
US Production: https://api.pymetrics.com
US Staging: https://staging.api.pymetrics.com
Usage
A full set of examples can be found in the pymetrics-assessments-api-client examples directory.
To get started, please request Client ID, Client Secret and API Key from pymetrics.
First, create a client for staging environment:
from pymetrics_assessment_api_client import Client
client = Client(base_url="https://staging.pymetrics.com")
To get an authenticated token, you can hit the get oauth endpoint by doing the following:
from pymetrics_assessment_api_client.models import OAuthTokenRequest
from pymetrics_assessment_api_client.api.default import mercury_o_auth
from pymetrics_assessment_api_client.models import OAuthTokenResponse
from pymetrics_assessment_api_client.types import Response
request = OAuthTokenRequest(client_id=client_id,
client_secret=client_secret,
grant_type="client_credentials")
auth_response: Response = mercury_o_auth.sync_detailed(client=client,
json_body=request)
auth_token_response: OAuthTokenResponse = auth_response.parsed
print(f"Access Token: {auth_token_response.access_token}")
To retrieve an order, you can use the token generated above and hit the get order endpoint:
from pymetrics_assessment_api_client.api.default import mercury_retrieve_order
from pymetrics_assessment_api_client.models import MercuryAssessmentOrder
from pymetrics_assessment_api_client.types import Response
auth = f"Bearer {access_token}"
get_order_response: Response = mercury_retrieve_order.sync_detailed(
client=client,
uuid=order_uuid,
authorization=auth,
x_api_key=API_KEY,
report=False
)
parsed_get_order_response: MercuryAssessmentOrder = get_order_response.parsed
print(f"Successfully retrieved order: {parsed_get_order_response.to_dict()}")
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for pymetrics-assessment-api-client-1.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2b4d9829af0e8637bd22f378050b73f1859ac13a77bfcf298aec7dee64546128 |
|
MD5 | 75428da6f1ebac7b91d09cef46984349 |
|
BLAKE2b-256 | 5d2c31a8438d9d0790ff1a78b2044d92a79c98b525f13a7d32f1a0cce3f42a05 |
Close
Hashes for pymetrics_assessment_api_client-1.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 034d61865c5d77c4cc53db51e75e02917b5443d05873de7065ee26b57667bd69 |
|
MD5 | 916af314376120c66f184536f47b56b3 |
|
BLAKE2b-256 | f038f0ca949ae0f0379bbae4723296400e7797154c82f4c8036e8aa073d7b657 |