Spanish Tax Agency Electronic Office (AEAT) Integration
Project description
Master |
Spanish Tax Agency Electronic Office (AEAT) Integration.
Make requests AEAT Web Services and sign your connection and xml using your certificate.
Integración con la Agencia Estatal de Administración Tributaria Española
Realiza peticiones a los Servicios Web de AEAT y firma tu conexión y mensajes XML utilizando tu certificado.
Usage (English)
Example for requesting a list of ENS’s.
Initialize a Config object with the desired preconfigured service and if you want to request AEAT test or production endpoints (test_mode). Finally initialize controller with the config and the desired certificate and make the request with your payload.
If you need more control just build the controller by hand, see build_from_config method for inspiration.
import aeat
config = aeat.Config('ens_presentation', test_mode=True)
ctrl = aeat.Controller.build_from_config(config, 'cert.pem', 'key.pem')
result = ctrl.request(payload) # See factories for examples
assert result.valid, f'Error requesting aeat: {result.error}'
assert result.data is not None
Usage (Spanish)
Ejemplo de consulta de ENSs.
Inicializa el objecto Config con el servicio preconfigurado y si quieres usar los endpoints de AEAT de test o de producción (test_mode). Por último inicializa el controlador con la config y el certificado que gustes y realiza la petición pasándole los datos que necesites.
Si necesitas un mayor control simplemente construye el controlador a mano, puedes inspirarte en el método build_from_config.
import aeat
config = aeat.Config('ens_presentation', test_mode=True)
ctrl = aeat.Controller.build_from_config(config, 'cert.pem', 'key.pem')
result = ctrl.request(payload) # Ver factories para ejemplos
assert result.valid, f'Error requesting aeat: {result.error}'
assert result.data is not None
Django Rest Framework
Several AEAT Validators and Serializers are provided.
Validators: Validate input data to send to AEAT
Serializers: Serialize AEAT request
from aeat.rest_framework import validators
validator = validators.ENSPresentationValidator(data=payload)
assert validator.is_valid(raise_exception=True)
# Send the request to AEAT
import aeat
config = aeat.Config(service_name, test_mode=settings.AEAT_TEST_MODE)
ctrl = aeat.Controller.build_from_config(config, cert_path, key_path)
result = ctrl.request(validator.data)
assert result.valid
# Parse the response
from aeat.rest_framework import serializers
serializer = serializers.get_class_for_aeat_response(data=result.data)
assert serializer.is_valid(raise_exception=False)
assert {'mrn': 'XXXX'} == serializer.data
assert not serializer.is_error
Prerequisites
Install xmlsec prerequisites. Check https://github.com/mehcode/python-xmlsec
Install
$ pip install aeat-web-services
Develop
$ python setup.py develop
$ pip install -r requirements_test.txt
Test
$ pip install tox
$ tox
Releases
Usefull Links
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
File details
Details for the file aeat-web-services-2.0.2.tar.gz
.
File metadata
- Download URL: aeat-web-services-2.0.2.tar.gz
- Upload date:
- Size: 62.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | d3ba04026ea2b95caa5f5692e788e1618f190d4468f6d0ff868c169025ea552a |
|
MD5 | d2d539d58a36dae0bf1fb33836573ce9 |
|
BLAKE2b-256 | 15627d3decb075126332d9931cfbc504b7a548cddb1c56bcdde782b14c4ec286 |
Provenance
File details
Details for the file aeat_web_services-2.0.2-py2.py3-none-any.whl
.
File metadata
- Download URL: aeat_web_services-2.0.2-py2.py3-none-any.whl
- Upload date:
- Size: 17.6 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | a0b8c90f47c1bef4d12bda9dd19b639131611d68e0c33739e2f6a368cdfbc7c6 |
|
MD5 | 8342675af362dedd3ab312cd708e96d2 |
|
BLAKE2b-256 | 97dc19b8db428f9fdc63acccbf0498de2333ee22d066546027802fbdd0b7d537 |