<p align="center">
<a href="https://www.inwx.com/en/" target="_blank">
<img src="https://images.inwx.com/logos/inwx.png">
</a>
</p>
INWX Domrobot Python 3 Client
=========
You can access all functions of our frontend via our API, which is available via the XML-RPC or JSON-RPC protocol and thus can be easily consumed with all programming languages.
There is also an OT&E test system, which you can access via [ote.inwx.com](https://ote.inwx.com/en/). Here you will find the known web interface which is using a test database. On the OT&E system no actions will be charged. So you can test as much as you like there.
Documentation
------
You can view a detailed description of the API functions in our documentation. You can find the online documentation [by clicking here](https://www.inwx.de/en/help/apidoc).
If you still experience any kind of problems don't hesitate to contact our [support via email](mailto:support@inwx.de).
Installation
-------
The recommended way is via pip:
```bash
pip install inwx-domrobot
```
You can find more information about the package on [pypi.org](https://pypi.org/project/inwx-domrobot).
Example
-------
```python
from INWX.Domrobot import ApiClient
username = ''
password = ''
domain = 'my-test-domain-which-is-definitely-not-registered6737.com'
api_client = ApiClient(api_url=ApiClient.API_OTE_URL, debug_mode=True)
login_result = api_client.login(username, password)
if login_result['code'] == 1000:
domain_check_result = api_client.call_api(api_method='domain.check', method_params={'domain': domain})
if domain_check_result['code'] == 1000:
checked_domain = domain_check_result['resData']['domain'][0]
if checked_domain['avail']:
print(domain + ' is still available!')
else:
print('Unfortunately, ' + domain + ' is already registered.')
else:
raise Exception('Api error while checking domain status. Code: ' + str(domain_check_result['code'])
+ ' Message: ' + domain_check_result['msg'])
api_client.logout()
else:
raise Exception('Api login error. Code: ' + str(login_result['code']) + ' Message: ' + login_result['msg'])
```
You can also have a look at the [example folder](INWX/examples) in the project for even more info.
License
----
MIT
Raw data
{
"_id": null,
"home_page": "https://github.com/inwx/python-client",
"name": "inwx-domrobot",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "INWX, API, PYTHON, CLIENT, DOMROBOT",
"author": "INWX Developer",
"author_email": "developer@inwx.de",
"download_url": "https://files.pythonhosted.org/packages/c2/59/7a4bbcc7028967a2431c34b6e0c5598fe6f8d1a426a102fcea569a9f160f/inwx-domrobot-3.2.0.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n <a href=\"https://www.inwx.com/en/\" target=\"_blank\">\n <img src=\"https://images.inwx.com/logos/inwx.png\">\n </a>\n</p>\n\nINWX Domrobot Python 3 Client\n=========\nYou can access all functions of our frontend via our API, which is available via the XML-RPC or JSON-RPC protocol and thus can be easily consumed with all programming languages.\n\nThere is also an OT&E test system, which you can access via [ote.inwx.com](https://ote.inwx.com/en/). Here you will find the known web interface which is using a test database. On the OT&E system no actions will be charged. So you can test as much as you like there.\n\nDocumentation\n------\nYou can view a detailed description of the API functions in our documentation. You can find the online documentation [by clicking here](https://www.inwx.de/en/help/apidoc).\n\nIf you still experience any kind of problems don't hesitate to contact our [support via email](mailto:support@inwx.de).\n\nInstallation\n-------\nThe recommended way is via pip:\n\n```bash\npip install inwx-domrobot\n```\n\nYou can find more information about the package on [pypi.org](https://pypi.org/project/inwx-domrobot).\n\nExample\n-------\n\n```python\nfrom INWX.Domrobot import ApiClient\n\nusername = ''\npassword = ''\ndomain = 'my-test-domain-which-is-definitely-not-registered6737.com'\n\napi_client = ApiClient(api_url=ApiClient.API_OTE_URL, debug_mode=True)\n\nlogin_result = api_client.login(username, password)\n\nif login_result['code'] == 1000:\n domain_check_result = api_client.call_api(api_method='domain.check', method_params={'domain': domain})\n\n if domain_check_result['code'] == 1000:\n checked_domain = domain_check_result['resData']['domain'][0]\n\n if checked_domain['avail']:\n print(domain + ' is still available!')\n else:\n print('Unfortunately, ' + domain + ' is already registered.')\n\n else:\n raise Exception('Api error while checking domain status. Code: ' + str(domain_check_result['code'])\n + ' Message: ' + domain_check_result['msg'])\n api_client.logout()\nelse:\n raise Exception('Api login error. Code: ' + str(login_result['code']) + ' Message: ' + login_result['msg'])\n```\n\nYou can also have a look at the [example folder](INWX/examples) in the project for even more info.\n\nLicense\n----\n\nMIT\n",
"bugtrack_url": null,
"license": null,
"summary": "INWX API Python Client",
"version": "3.2.0",
"project_urls": {
"Download": "https://github.com/inwx/python-client/archive/v3.2.0.tar.gz",
"Homepage": "https://github.com/inwx/python-client"
},
"split_keywords": [
"inwx",
" api",
" python",
" client",
" domrobot"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3bdae82deffd568721ac4b67defa9159b54745454d065887484eab027bda89fd",
"md5": "312e5a3f29ee53e951798e3f4a1df96d",
"sha256": "b852e57cf2e26e1b45531291a6e945c9382bbefd50c29ba87fb4753b8edfe35a"
},
"downloads": -1,
"filename": "inwx_domrobot-3.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "312e5a3f29ee53e951798e3f4a1df96d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5783,
"upload_time": "2024-04-04T11:23:29",
"upload_time_iso_8601": "2024-04-04T11:23:29.445632Z",
"url": "https://files.pythonhosted.org/packages/3b/da/e82deffd568721ac4b67defa9159b54745454d065887484eab027bda89fd/inwx_domrobot-3.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c2597a4bbcc7028967a2431c34b6e0c5598fe6f8d1a426a102fcea569a9f160f",
"md5": "807d517c6e6d7ddac44ff677abff0659",
"sha256": "190385c90be907431e0c669836d9926a9cae4a69518f3b483da34c781f2e3afb"
},
"downloads": -1,
"filename": "inwx-domrobot-3.2.0.tar.gz",
"has_sig": false,
"md5_digest": "807d517c6e6d7ddac44ff677abff0659",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 5390,
"upload_time": "2024-04-04T11:23:31",
"upload_time_iso_8601": "2024-04-04T11:23:31.136195Z",
"url": "https://files.pythonhosted.org/packages/c2/59/7a4bbcc7028967a2431c34b6e0c5598fe6f8d1a426a102fcea569a9f160f/inwx-domrobot-3.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-04 11:23:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "inwx",
"github_project": "python-client",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "inwx-domrobot"
}
JSON
