SDK para integração com a API da Sympla
Project description
SymplaTools SDK
SymplaTools é um SDK para integração com a plataforma Sympla, atualmente incluindo funcionalidades como:
- Validação de QR codes assinados com ECDSA.
Pypi
Este projeto está em um repositório público, e tem como objetivo facilitar o uso das funcionalidades da Sympla.
https://pypi.org/project/sympla_tools/
Também disponível no package registry do gitlab
https://gitlab.com/symplax/sympla-tools/-/packages
Instalação
Para instalar as dependências, use Poetry:
### Pypy
poetry add sympla-tools
### Package registry Gitlab
poetry add git+ssh://git@gitlab.com:gitlab.com/symplax/sympla-tools/-/packages#0.1.5
Configuração
Para validar a assinatura, é necessário definir o endereço Ethereum conhecido (KNOWN_ETHEREUM_ADDRESS) como uma variável de ambiente. Este será o endereço usado para verificar a autenticidade da assinatura do QR code.
Configure o endereço Ethereum conhecido com o seguinte comando:
export KNOWN_ETHEREUM_ADDRESS="0xdB074b3c323A7Ad418EBBe66baD231f43f680563"
Uso
Após configurar o endereço Ethereum, você pode usar o SDK para validar a assinatura de um QR code Ethereum.
Você vai precisar ler o Qrcode
Para realizar a validação, será necessário construir o json contendo os campo em ordem:
- address
- ItemTypeId
Além do json, é necessário resgatar a assinatura (signature)
Exemplo de uso via linha de comando
Para validar uma assinatura via linha de comando, execute:
python -m sympla_tools.tickets.signature.token validate '{"address": "0x3e3857e99BE213aA914942C6482c33161Df51E16", "ItemTypeId": "37884525610813"}' '0x1e6912e765694db61b5291c94469ba339f1b7da3e921d5c3acd8ced279565053120e3e866c0158fe0eeddefdd113303adc1e56e79a9f1503386251786d4881f31b'
Substitua "ASSINATURA" pela assinatura que deseja validar. O SDK verificará se a assinatura corresponde ao endereço Ethereum configurado.
Funções Principais
- validate: Função principal para validar uma assinatura Ethereum. A função compara a assinatura com o endereço configurado e retorna se a assinatura é válida.
Project details
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 sympla_tools-0.2.4.tar.gz.
File metadata
- Download URL: sympla_tools-0.2.4.tar.gz
- Upload date:
- Size: 5.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.4 CPython/3.10.14 Linux/5.15.154+
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e344e5493b7fa251230421ea2f6cc3c467ac12b63ea01f279211fbd10a3e7c30
|
|
| MD5 |
db374379f0325c938f9c7268e4868645
|
|
| BLAKE2b-256 |
8f476ff80e85c590b64b33090780c77efe4641271885a03ccb1398dddc71f3a8
|
File details
Details for the file sympla_tools-0.2.4-py3-none-any.whl.
File metadata
- Download URL: sympla_tools-0.2.4-py3-none-any.whl
- Upload date:
- Size: 6.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.4 CPython/3.10.14 Linux/5.15.154+
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4a878f7809f48ceb56a2cf37a76bd5a141e0318178b8f8a8296f0a66cf2ae067
|
|
| MD5 |
4cba288322ae306fc46b92bd36d9c967
|
|
| BLAKE2b-256 |
78d7e651cb2ff4f77526a4815d7e74b7d9c5d3bad5b6c9f238e3e6cdee18882d
|