Skip to main content

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="0x0ff5a47F678e1E490b9c467631Ab84Dc1665a7eA"

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

sympla_tools-0.1.8.tar.gz (3.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sympla_tools-0.1.8-py3-none-any.whl (5.3 kB view details)

Uploaded Python 3

File details

Details for the file sympla_tools-0.1.8.tar.gz.

File metadata

  • Download URL: sympla_tools-0.1.8.tar.gz
  • Upload date:
  • Size: 3.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.10.14 Linux/5.15.154+

File hashes

Hashes for sympla_tools-0.1.8.tar.gz
Algorithm Hash digest
SHA256 80504a175a755682bc946473354b15de8af2734bc9307a017a3fbd94915d35ee
MD5 e7b1caff584b54ff00aa9e0232c06ce6
BLAKE2b-256 45db3554ddc64ce2edfed3999406ce0df8139d1a64d0930bfc9a999c155435bc

See more details on using hashes here.

File details

Details for the file sympla_tools-0.1.8-py3-none-any.whl.

File metadata

  • Download URL: sympla_tools-0.1.8-py3-none-any.whl
  • Upload date:
  • Size: 5.3 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

Hashes for sympla_tools-0.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 e256c70dceb3fe7ed28d18beada7904ad83e88adbb8a4f6141e0ec2c39410f67
MD5 1cf1f1723876e68245d4394450650a26
BLAKE2b-256 7f2176028b552b8174a038ce5bcbc19e624fb1cafb62724fc262559635942c0c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page