Project description
A library for accessing the SPEI API and SICE API for python.
Installation
Use the package manager poetry to install.
poetry install spei-python
Usage
Use our client to send orders to SPEI.
from spei.client import BaseClient
client = BaseClient(
host='http://karpay-beta.intfondeadora.app',
username='karpay',
password='password',
priv_key='private_key',
priv_key_passphrase='passphrase',
)
Use our client to send orders to SICE.
from spei.sice import BaseClient
client = BaseClient(
host='https://172.30.3.204:8443',
)
Methods
Resources
There are four main resources.
- Orden our abstraction of order, this goes through SPEI as XML.
- Respuesta our abstraction of received SPEI messages and response to SPEI orders.
- CDA our abstraction of cda, this goes through SICE as XML.
- Acuse our abstraction of received SICE messages and confirmation message to SICE.
Types
Requests
These are used to perform requests to karpay using our resources.
Responses
These are used to map karpay results to our resources.
Errors
Available errors messages from Karpay.
These errors are included inside respuesta.
Test
Tested with mamba, install poetry dev packages and then run tests.
poetry run make test
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
License
Checksum Generator
This repo includes a utility to generate firma digital aplicada
python bin/generate_checksum.py bin/message.json
Download files
Download the file for your platform. If you’re not sure which to choose, learn more about installing packages.