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="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.ethereum_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.

Gerando um binário

Este projeto consegue rodar através de um binário, para isto você precisa gerar o build do pacote

python sympla_tools/scripts/build_binary.py

### depois copie o binario gerado para a pasta bin
/usr/local/bin

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.3.1.tar.gz (7.2 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.3.1-py3-none-any.whl (9.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sympla_tools-0.3.1.tar.gz
  • Upload date:
  • Size: 7.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

Hashes for sympla_tools-0.3.1.tar.gz
Algorithm Hash digest
SHA256 4c60e1530eb6b26993980a4a85a65d20165c8b52b092cfd51e04425d54569dd7
MD5 79906bd5e963a14de2fdc0d63be00cb1
BLAKE2b-256 f9ecb887e332628c6dc4dea6736ea8b46ada5e4b8d1cb47ae7aa58d8f67f17dd

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sympla_tools-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 9.6 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.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7371de67b0a8fd43b06c5992e59d43462fb8a8a01d6573880dde9a16ee5d26bb
MD5 f190c266411a5d548a2dc1de2f9d98c5
BLAKE2b-256 1791b1a4445023db0c7427b2e170859b01c5e70e87c8c517967943f8e93d28d2

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