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.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.3.0.tar.gz (7.0 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.0-py3-none-any.whl (9.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sympla_tools-0.3.0.tar.gz
  • Upload date:
  • Size: 7.0 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.0.tar.gz
Algorithm Hash digest
SHA256 1ec60ec49395249cc4fc2ab6cb5fd5d2dcd97d022402c035d44c70fcb21360cb
MD5 9064b2124d56a72db92f85002c6b454f
BLAKE2b-256 d17472b9d9bba1f936a51b800841b707e95f65e8878e6f60d106e35e3a046304

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sympla_tools-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 9.4 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ff9c1cd54c71b90ebe8df8e44a7fbeb78aac5fbb943d100db2c3e3baf72badcb
MD5 d72c2149f862c60681c5fb7233c9e38a
BLAKE2b-256 2af7b8a42144467a9616c42703a4383b3d8c6752d259074c6685b806f4e66b7d

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