Basis Theory Python SDK
The Basis Theory Python SDK for Python >=3.7
Installation
pip install
From the git repository
pip install git+https://github.com/Basis-Theory/basistheory-python.git
(you may need to run pip with root permission: sudo pip install git+https://github.com/Basis-Theory/basistheory-python.git)
Then import the package:
import basistheory
Setuptools
Install via Setuptools.
python setup.py install --user
(or sudo python setup.py install to install the package for all users)
Then import the package:
import basistheory
Locally
To install your latest changes locally run:
python3 -m pip install .
Documentation
If you need any assistance, please contact support@basistheory.com at this time.
Client Methods
All URIs are relative to https://api.basistheory.com
| Class | Method | HTTP request |
|---|---|---|
| TokensApi | create | POST /tokens |
| TokensApi | delete | DELETE /tokens/{id} |
| TokensApi | get_by_id | GET /tokens/{id} |
| TokensApi | list | GET /tokens |
Models
Usage
Per-request configuration
All of the client methods accept an optional RequestOptions object.
This is
used if you want to set a correlation ID or if you want to set a per-request BT-API-KEY
import uuid
import basistheory
from basistheory.request_options import RequestOptions
request_options = RequestOptions(api_key="API KEY", correlation_id=uuid.uuid4())
Client Configuration
Each Api client can be configured to use a custom API url and client-wide BT-API-KEY.
import basistheory
from basistheory.api import tokens_api
configuration = basistheory.Configuration(
host = "https://token-proxy.somedomain.com",
api_key = "API KEY"
)
with basistheory.ApiClient(configuration) as api_client:
# Create a token client w/ global configuration for all requests
token_client = tokens_api.TokensApi(api_client)
Getting Started
Quick example creating a token and then retrieving it.
import uuid
import basistheory
from pprint import pprint
from basistheory.api import tokens_api
from basistheory.model.create_token_request import CreateTokenRequest
from basistheory.request_options import RequestOptions
# Defining client wide api_key
configuration = basistheory.Configuration(
api_key = "API KEY"
)
with basistheory.ApiClient(configuration) as api_client:
# Create an instance of the tokens API client
token_client = tokens_api.TokensApi(api_client)
# Setting a correlation Id
request_options = RequestOptions(correlation_id=uuid.uuid4().__str__())
# Token request object
request = CreateTokenRequest(type="token", data="My Secret Data")
try:
# Creating the token
created_token = token_client.create(create_token_request=request, request_options=request_options)
pprint(created_token)
# Retrieving it (requires read permission on the token type classification and impact level)
retrieved_token = token_client.get_by_id(id=created_token.id)
pprint(retrieved_token)
except basistheory.ApiException as e:
print("Exception when calling TokensApi: %s\n" % e)
1 maintainer
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file basistheory-3.0.0.tar.gz.
File metadata
- Download URL: basistheory-3.0.0.tar.gz
- Upload date:
- Size: 108.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/5.1.1 CPython/3.8.18
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4c55e8f5a63c07ec22ec3ac43a83dae729341c2dcdf8eae4e65fa9c9c0165466
|
|
| MD5 |
ee68e68ab7a548c959c4c68635232543
|
|
| BLAKE2b-256 |
f6674ca9eff8f0acf9ebf42a61f26947229f5eca2c33734d4ff2257291bf7d14
|
File details
Details for the file basistheory-3.0.0-py3-none-any.whl.
File metadata
- Download URL: basistheory-3.0.0-py3-none-any.whl
- Upload date:
- Size: 390.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/5.1.1 CPython/3.8.18
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
702119c56d4067d2eedb38c2a4aade73eb272147a724491c80114afecb27ca9c
|
|
| MD5 |
0afcab4b610d5ed3f0e7fa9582e54379
|
|
| BLAKE2b-256 |
98edc5c56fc0b8c19128eb294fa461f0908e5005e41af790b466e038ac9e85c4
|
