GClick SDK
SDK Python para integração com a plataforma de controle de processos GClick.
Este SDK foi construído com base na documentação oficial das APIs.
Features disponíveis (por classe)
- GClickCredentials - Classe de controle da autenticação com o portal do GClick.
- AtividadesClient - Classe para manipulação das atividades na plataforma.
gclick_sdk.credentials.GClickCredentials
Controle de autenticação com o portal do GClick (obtenção de access_token, pelo protoco OAuth). Disponibiliza os seguintes métodos públicos:
Construtor padrão
Retorna uma instância da classe, necessária para construção das classes "client" (para manipulação de dados na plataforma).
Parâmetros
- sistema: Código do sistema informado pelo G-Click (para integração).
- usuario: Apelido do usuário no sistema parceiro correspondente ao apelido do usuário no G-Click.
- conta: Conta de acesso do usuário junto ao GClick
- senha: Senha de acesso do usuário junto ao GClick
- empresa: Código da empresa parceira provido pelo GClick, para integração.
- client_id: ID da aplicação cliente cadastrada no servidor de autenticação.
- client_secret: Chave da aplicação cliente cadastrada no servidor de autenticação.
gclick_sdk.atividades_client.AtividadesClient
Client para invocação dos endpoints destinados à manipulação de Atividades no GClick.
baixar_upload()
Realiza a baixa de atividade, realizando também upload de arquivo associado.
Retorno
Método sem retorno esperado (ver sessão de exceções para o caso de erro no processamento).
Parâmetros
- id_atividade: ID da atividade.
- inscricao: Inscrição do cliente do escritório contábil (CPF ou CNPJ).
- competencia: Data da competência no formato AAAAMM.
- file_content: Conteúdo, em bytes, do arquivo a sofrer upload.
- file_name: Nome do arquivo sofrendo upload.
- file_mimetype: Mimetype do arquivo sofrendo upload.
- usuario [opcional]: Apelido do usuário no sistema parceiro.
Obs.: Se o parâmetro "usuario" não for passado, será assumido o usuário recebido com o objeto de credenciais (no construtor da classe).
Exceções
- BaixadaAnteriormenteException: Indica que a atividade já foi baixada anteriormente (não podendo ser baixada diretamente, apenas atualizada, o que ainda não está implementado).
- UnauthorizedException: Erro de autenticação, contendo mensagem de erro descritiva, porém seguem algumas possíveis causas:
- conta ou senha incorretos (no objeto GClickCredentials).
- empresa ou sistema incorretos (no objeto GClickCredentials).
- client_id ou client_secret incorretos (no objeto GClickCredentials).
- AtividadeNotFoundException: Atividade pendente não encontrada, causas prováveis:
- inscrição da empresa cliente incorreto.
- id_atividade incorreto.
- competencia incorreta.
- BaixaUnknowException: Erro desconhecido inesperado na requisição. Possíveis causas:
- Chamada à API da GClick com retorno HTTP 400.
- Faltando um ou mais parâmetros do arquivo para upload.
- HTTPError: Erro desconhecido inesperado no processamento (retorno HTTP 500 ou outros, consultar a mensagem da exceção).
- Exception: Erro desconhecido.
Metadata
Release files for gclick-sdk 0.0.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| gclick_sdk-0.0.3.tar.gz | 5.9 kB | Without provenance | Details for gclick_sdk-0.0.3.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| gclick_sdk-0.0.3-py3-none-any.whl | Python 3 | none | any | Details for gclick_sdk-0.0.3-py3-none-any.whl |
Total release size: 12.5 kB
Release files / gclick_sdk-0.0.3.tar.gz
| Download URL | gclick_sdk-0.0.3.tar.gz |
|---|---|
| Size | 5.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f236ed653d482261cc4c267e9645cbf964602d5a015819fbe4124642342c4074
|
|
BLAKE2b-256 checksum How to use checksums |
ff574cf03ca3fcc70a9efbcd5a720ab5751d243d2e8672e4774387447e8ea078
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.8.10
|
Release files / gclick_sdk-0.0.3-py3-none-any.whl
| Download URL | gclick_sdk-0.0.3-py3-none-any.whl |
|---|---|
| Size | 6.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
7b128f6e33e2103b4a54c50a32f5d8acf168eb82480f949223ebacc912de8eaf
|
|
BLAKE2b-256 checksum How to use checksums |
ebab7e6a2bc4606accbe5ed66ff2742d0d45dcb048b657be9372fad45476109b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.8.10
|
Security for gclick-sdk 0.0.3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.