{"id":24977921,"url":"https://github.com/gersonfreire/soawebservices","last_synced_at":"2025-10-16T11:26:04.549Z","repository":{"id":273141400,"uuid":"918738959","full_name":"gersonfreire/soawebservices","owner":"gersonfreire","description":"SOA WebServices SDK and CLI (command line interface)","archived":false,"fork":false,"pushed_at":"2025-01-21T20:34:29.000Z","size":29,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-30T00:04:43.475Z","etag":null,"topics":["cnh","cnpj","cnpj-validator","cpf","cpf-validador","kyc","processos","rfb","serasa","soawebservices"],"latest_commit_sha":null,"homepage":"https://www.soawebservices.com.br/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gersonfreire.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-01-18T18:20:31.000Z","updated_at":"2025-01-21T20:33:33.000Z","dependencies_parsed_at":"2025-03-29T08:44:41.246Z","dependency_job_id":"cce723ad-12f9-4626-bd33-a0488fbfb593","html_url":"https://github.com/gersonfreire/soawebservices","commit_stats":null,"previous_names":["gersonfreire/soawebservices"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/gersonfreire/soawebservices","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gersonfreire%2Fsoawebservices","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gersonfreire%2Fsoawebservices/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gersonfreire%2Fsoawebservices/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gersonfreire%2Fsoawebservices/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gersonfreire","download_url":"https://codeload.github.com/gersonfreire/soawebservices/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gersonfreire%2Fsoawebservices/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279183320,"owners_count":26121376,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-16T02:00:06.019Z","response_time":53,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cnh","cnpj","cnpj-validator","cpf","cpf-validador","kyc","processos","rfb","serasa","soawebservices"],"created_at":"2025-02-03T23:42:18.654Z","updated_at":"2025-10-16T11:26:04.532Z","avatar_url":"https://github.com/gersonfreire.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SOA WebServices SDK\n\n[🇧🇷 Versão em Português](README_pt.md)\n\nA Python SDK and CLI for interacting with SOA WebServices API ([SOAWebservices Web Site](https://www.soawebservices.com.br/))\n\n# SOA WebServices SDK\n\n## Installation\n\n1. Clone the repository\n2. Install dependencies:\n\n```bash\npip install -r requirements.txt\n```\n\n3. Configure environment variables in `.env`:\n\n```\nBASE_URL=https://homologacao.soawebservices.com.br\nPROD_BASE_URL=https://services.soawebservices.com.br\nEMAIL=\u003cyour-sowawebservices-username\u003e\nPASSWORD=\u003cyour-sowawebservices-password\u003e\n```\n\n## Where to manage your account and get the credentials:\n\n* [SOAWebServices Portal](https://portal.soawebservices.com.br/Identity/Login)\n* [SOAWebservices Web Site](https://www.soawebservices.com.br/)\n\n## Usage\n\n### As a Library\n\n```python\nfrom soa_sdk.client import SOAWebServicesClient\n\n# Initialize client\nclient = SOAWebServicesClient()\n\n# Get account balance\nbalance = client.get_saldo()\n\n# Get synthetic statement\nstatement = client.get_extrato_sintetico(2023, 12)\n\n# Get NFe information for individual\nnfe = client.get_pessoa_fisica_nfe(\"12345678900\", \"1990-01-01\")\n```\n\n### Using the CLI\n\n```bash\n# Get account balance\nsoa-cli saldo\n\n# Get synthetic statement\nsoa-cli extrato-sintetico --ano 2023 --mes 12\n\n# Get NFe information for individual\n\n\n# Get NFe information for company\nsoa-cli pessoa-juridica-nfe --documento 12345678000190\n```\n\n## Features\n\n- Complete API coverage\n- Automatic logging to file and console\n- Type validation using Pydantic\n- Rich CLI interface\n- Environment-based configuration\n\n## Logging\n\nLogs are written to `logs/soa_sdk.log` and rotated when they reach 10MB in size. The last 5 log files are kept.\n\n## Error Handling\n\nThe SDK includes comprehensive error handling and logging. All API errors are logged and raised as exceptions.\n\n## References:\n\n* [Services status](https://status.i-stream.com.br/status/servicos)\n* [API Swagger docs](https://services.soawebservices.com.br/documentacao/index.html)\n* [New CNPJ](https://github.com/gersonfreire/novo-cnpj)\n* [Telegram Bot](https://t.me/PessoaBot)\n\n## How to Contribute\n\n1. Fork the repository\n2. Create a new branch (`git checkout -b feature-branch`)\n3. Make your changes\n4. Commit your changes (`git commit -m 'Add new feature'`)\n5. Push to the branch (`git push origin feature-branch`)\n6. Open a Pull Request\n\n---\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgersonfreire%2Fsoawebservices","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgersonfreire%2Fsoawebservices","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgersonfreire%2Fsoawebservices/lists"}