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.2.2.tar.gz (3.9 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.2.2-py3-none-any.whl (5.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sympla_tools-0.2.2.tar.gz
  • Upload date:
  • Size: 3.9 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.2.2.tar.gz
Algorithm Hash digest
SHA256 f90c88fb9ec58be3d28bf099b83e109aa6589102d8c58bbb241dc6981c66dcb5
MD5 202d8d4bbbc8bdcac8919b3a37f581bb
BLAKE2b-256 13c1a85ee7a1fbfbc6ed6a9930e0a2ba2f329da4037fea1c2b4cc5b62a650565

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sympla_tools-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 5.2 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.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 dc16b3c56ca5f0e17d493388ab69cccbc5a3c6a9604ae7970ee77bcc7615b2b4
MD5 a72ea00140b5818c04ab08f70498ddb2
BLAKE2b-256 92e566fd9289e06e757909fc72e66a89a9fa12f20013a377240ccf3a9d9c27fa

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