Client python package for interaction with APIClarity.
Project description
Python APIClarity client
Python client package for APIClarity interaction.
APIClarity is a modular tool that addresses several aspects of API Security, focusing specifically on OpenAPI based APIs. APIClarity approaches API Security in 2 different ways:
- Captures all API traffic in a given environment and performs a set of security analysis to discover all potential security problems with detected APIs
- Actively tests API endpoints to detect security issues in the implementation of such APIs.
Usage
The ClientSession
class is based on requests.Session and can be used similarly. To configure the session, provide a ClientSettings
object:
from apiclarity import ClientSession, ClientSettings
apiclarity_session = ClientSession(ClientSettings(
apiclarity_endpoint="http://apiclarity",
default_timeout=(9.0, 3.0),
))
apiInfo = apiclarity_session.getInventory()
for api in apiInfo.items:
print(f"received: {api}\n")
The settings can also be retrieved from the environment during creation of the ClientSettings
object, given here with the defaults:
APICLARITY_ENDPOINT="http://apiclarity:8080"
TELEMETRY_ENDPOINT="http://apiclarity:9000"
HEALTH_ENDPOINT="http://apiclarity:8081"
Contributing
Pull requests and bug reports are welcome. Please see CONTRIBUTING.md.
License
The code is released under the Apache 2.0 License.
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
Hashes for apiclarity-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9f3ec283c4fc8775e102e0385fc9a402b9f94100e6410483e0e8f8384836f535 |
|
MD5 | d83657f8108879a4bec05f9b04eec703 |
|
BLAKE2b-256 | 4847faa2ff18b9c2874f90f47d476071f6b92d4d4251b3018f9494a066b7daa2 |