The client is implemented via the Facade pattern, so the necessary function is called as follows:
client.<module>.<sub_module>.function()See client structure below
CybertonicaAPI client can be installed using pip:
pip install git+https://github.com/cybertonica/cybertonica-client.gitTo test that installation was successful, try:
>>> from CybertonicaAPI import Client
>>> cbt = Client(url='https://test.cybertonica.com',team='test')
>>> status, data = cbt.auth.login('login', 'password')
>>> f'{status} | {cbt.token}'
'200 | 37d9c47b-4837-44db-9dbe-b5427eb70b43'>>> from CybertonicaAPI import Client
>>> cbt = Client(url='https://test.cybertonica.com',team='test')
>>> status, data = cbt.auth.login('login', 'password')
>>> cbt.events.get_by_id('eve_global:8dd5fc24-3fc2-4e7c-a909-94afbe44931a')
(200, {'_cls': 'eve_global', 'channel': 'global', ... })
>>> cbt.lists.create({"name":"simple_list","kind":"WHITE"})
(201, {'createdAt': 1591179867918, 'createdBy': ... })
>>> cbt.lists.get_by_id('e166502a-8332-4317-9421-edd9dcca7694')
(200, {'createdAt': 1591179867918, 'createdBy': ... })
>>> cbt.lists.create("bad_structure")
AssertionError: The data type must be a dictionaryIf you need to use Anti-Fraud subsystem API, add two parameters and send the event to the system:
>>> from CybertonicaAPI import Client
>>> cbt = Client(url='https://test.cybertonica.com',team='test')
>>> cbt.api_user_id = 'api_user_id'
>>> cbt.api_signature = 'api_signature'
>>> cbt.af.create({"channel":"global","sub_channel":"sys"})
(200, {'action': 'ALLOW', 'channel': 'global', ...})The client has logging. To see more detailed information about the client's work, do this:
from CybertonicaAPI import Client
import logging
logging.basicConfig(level=logging.DEBUG)
cbt = Client(url='https://test.cybertonica.com',team='test')
# DEBUG:CybertonicaAPI.client:Client has been init with {'url': 'https://test.cybertonica.com', 'team': 'test'}
cbt.auth.login('login','password')
# DEBUG:CybertonicaAPI.client:Trying POST request to https://test.cybertonica.com/api/v1/login with body={"apiUser": "login", "team": "test", "apiUserKeyHash": "password_hash"} headers={'content-type': 'application/json'} files=None verify=False
# Case: the server is not available. All errors will be saved in logs.
cbt = Client(url='https://test-test-test.cybertonica.com',team='test')
# DEBUG:CybertonicaAPI.client:Client has been init with {'url': 'https://test-test-test.cybertonica.com', 'team': 'test'}
# DEBUG:CybertonicaAPI.client:Trying GET request to https://test-test-test.cybertonica.com/api/v1/info with body=None headers=None files=None verify=True
# DEBUG:urllib3.connectionpool:Starting new HTTPS connection (1): test-test-test.cybertonica.com:443
# DEBUG:CybertonicaAPI.client:ConnectionError(MaxRetryError("HTTPSConnectionPool(host='test-test-test.cybertonica.com', port=443): Max retries exceeded with url: /api/v1/info (Caused by NewConnectionError('<urllib3.connection.HTTPSConnection object at 0x7f3f148b82b0>: Failed to establish a new connection: [Errno -2] Name or service not known',))",),)Each class or method contains a docstring
>>> print(cbt.__doc__)
Main Facade class. Contains all methods.
Attributes:
**settings: Set of settings for the class. It must contains a
required parameters: `url`, `team`. If you want to use
`CybertonicaAPI.afclient.AFClient` you should include
`api_user_id` and `api_signature` to settings.
url: target url of environment.
team: value of team.
custom_af_url: AFClient will use the specified address.
By default, the address is equal to a url with a port 7499.
api_user_id: user id for AF.
api_signature: value of signature for AF.
verify: True, if you need to ignore SSL certificates.
dev_mode: True, if you need enable hidden functions.Version 2.1 is deprecated, but supported. The client has the opportunity to work with both versions.
To specify the anti fraud version, use the af_version field.
>>> from CybertonicaAPI import Client
>>> cbt = Client(url='https://test.cybertonica.com',team='test')
>>> cbt.api_user_id = 'api_user_id'
>>> cbt.api_signature = 'api_signature'
>>> cbt.af_version = 'v2.2'
>>> cbt.af.create(<parametres>)
DEBUG:urllib3.connectionpool:https://test.cybertonica.com:7499 "POST /api/v2.2/events/global?subChannel=sys HTTP/1.1" 200 161
>>> cbt.af_version = 'v2.2'
>>> cbt.af.create(<parametres>)
DEBUG:urllib3.connectionpool:https://test.cybertonica.com:7499 "POST /api/v2.1/createEvent HTTP/1.1" 200 144cbt.af.update() also supports this functionality.
If you need to perform your personal testing and send "something correct" to the system, you can use this module.
Box is a simple structure generator for the AF system.
>>> from CybertonicaAPI import Client
>>> cbt = Client(url='https://test.cybertonica.com',team='test')
>>> cbt.api_user_id = 'api_user_id'
>>> cbt.api_signature = 'api_signature'
>>> cbt.af_version = 'v2.2'
>>> cbt.af.box.pull_create_event('global','sys','requiered') # v2.2 version
{} # this is the minimum structure for the global channel event and v2.2 version
>>> cbt.af.create(_, 'global', 'sys'))
(200, {'action': 'ALLOW', ...})
>>> cbt.af.box.pull_create_event('global','sys','all')
{'t': 159198363, 'timezone': 204, 'extid': 'm', 'tid': 'gSUhnEyl', ...} # all keys for the v2.2 version
>>> cbt.af.create(_, 'global', 'sys'))
(200, {'action': 'ALLOW', ...})Box also supports system versioning:
>>> ...
>>> cbt.af_version = 'v2.2'
>>> cbt.af.box.pull_create_event('global','sys','requiered')
{}
>>> cbt.af_version = 'v2.1'
>>> cbt.af.box.pull_create_event('global','sys','requiered')
{'channel': 'global', 'sub_channel': 'sys'}You can find out which channels are supported by a simple command:
>>> ...
>>> cbt.af.box.allowed_channels
dict_keys(['global', 'session', 'payment', 'acquiring', ...])A module that allows you to perform rapid smoke-testing for an Antifraud system:
>>> from CybertonicaAPI import Client
>>> cbt = Client(url='https://test.cybertonica.com',team='test')
>>> cbt.api_user_id = 'api_user_id'
>>> cbt.api_signature = 'api_signature'
>>> cbt.af.auditor.run()
The test v2.2 protocol (https://test.cybertonica.com:7499) was launched ...
v2.2 - DONE
The test v2.1 protocol (https://test.cybertonica.com:7499) was launched ...
v2.1 - DONE| Code | Description |
|---|---|
| 201 | The request has been fulfilled, resulting in the creation of a new resource. |
| 204 | The server successfully processed the request and is not returning any content. |
| 400 | The server cannot or will not process the request due to an apparent client error. |
| 401 | The authentication is required and has failed or has not yet been provided. |
| 403 | The request was valid, but the server is refusing action. The user might not have the necessary permissions for a resource. |
| 404 | The requested resource could not be found but may be available in the future. |
| 409 | The request could not be processed because of conflict in the request, such as an edit conflict between multiple simultaneous updates. |
| 423 | The resource that is being accessed is locked. |
| 500 | There was an internal server error. |
| 502 | The server was acting as a gateway or proxy and received an invalid response from the upstream server. |
client.abtests
create
delete
get_all
get_by_id
start
stop
update
client.af
client.af.box
pull_create_event
pull_update_event
client.af.auditor
run
create
update
client.auth
login
logout
recovery_password
register
client.cases
create
delete
get_all
update
client.channels
get_all
client.events
bulk_review
get_by_id
get_by_queue
review
search
client.lists
client.lists.items
create
delete
get_all
get_by_id
get_by_pattern
update
create
delete
get_all
get_by_id
kinds
update
import_csv
export_csv
client.policies
create
delete
get_all
get_by_id
update
execute
client.queues
delete
get_all
client.roles
delete
get_all
create
update
raw_create
raw_update
search_by_id
client.settings
get_all
update
client.subchannels
create
delete
get_all
get_by_id
search_by
update
client.users
add_role
create
delete
get_all
get_by_id
remove_role
update
client.tech
info
ping
paths
client.schema
get_all
get_by_id
create
update
delete
client.currencies
get_by_code
get_union_base
client.bi
get
export
search
client.bins
get
client.geo
get
client.reports
sendgit clone https://github.com/cybertonica/cybertonica-client.git@develop .git clone https://github.com/cybertonica/cybertonica-client.git .python -m unittest discover -s tests -p "*.py"pip install .
&& python3 -c "from CybertonicaAPI import Client; c = Client(url='https://test.com',team='test')"
&& yes | pip uninstall CybertonicaAPIpip install pdoc
pdoc --html --config show_source_code=False --force CybertonicaAPI
ls ./html/CybertonicaAPI
abtests.html auth.html channels.html events.html lists.html queues.html settings.html users.html
afclient.html cases.html client.html index.html policies.html roles.html subchannels.html