<p align="center"><img alt="logo" src="https://www.zypp.io/static/assets/img/logos/zypp/black/500px.png" width="200"></p>
<br>
[](https://pepy.tech/project/easyflex)
[](https://opensource.org/)
# Easyflex dataservices API voor python
> Dit project bevat python scripts voor het ontsluiten van data uit de easyflex API.
## Project documentatie
- [Introductie](#introductie)
- [Hoe moet je dit project gebruiken?](#hoe-moet-je-dit-project-gebruiken?)
- [Simpel voorbeeld](#simpel-voorbeeld-zonder-velden-of-parameters)
- [Voorbeeld met parameters en velden](#voorbeeld-met-parameters-en-velden)
# Introductie
Easyflex heeft een API ontwikkeld voor het ontsluiten van data. Op basis van de [Easyflex web- en dataservices documentatie](https://confluence.easyflex.net/display/WEBDATAKLNT/Web-+en+dataservice) is dit python project ontstaan.
Het doel van het project is om snel en efficient data te ontsluiten van 1 of meerdere Easyflex administraties.
# Hoe moet je dit project gebruiken?
In twee stappen is het mogelijk om data te ontsluiten. De eerste stap is het initialiseren van de class `Easyflex`. In deze class registreren worden de API keys geregistreerd die gebruikt worden bij de uitvraag.
De tweede stap is het uitvragen van de dataservices of webservices. Hier moet een module naam worden opgegeven. Vervolgens kunnen de parameters en velden worden opgegeven, conform de [documentatie van de modules](https://confluence.easyflex.net/display/WEBDATAKLNT/1.2+ds_wm_medewerkers).
### Simpel voorbeeld zonder velden of parameters
```python
from easyflex import Easyflex
api_keys = {"<YOUR_ADM_CODE>": "<YOUR_API_KEY>","<YOUR_ADM_CODE_2>": "<YOUR_API_KEY_2>"}
ef = Easyflex(api_keys, service="dataservice")
data = ef.query(module="ds_wm_medewerkers")
```
### Voorbeeld met parameters en velden
```python
from easyflex import Easyflex
api_keys = {"<YOUR_ADM_CODE>": "<YOUR_API_KEY>","<YOUR_ADM_CODE_2>": "<YOUR_API_KEY_2>"}
ef = Easyflex(api_keys, service="dataservice")
data = ef.query(module="ds_wm_locaties",
parameters={"status": 21690},
velden=["wm_locatie_nummer", "wm_locatie_code", "wm_locatie_naam"])
```
## Onderhouden door:
- [Zypp](https://github.com/zypp-io)
Raw data
{
"_id": null,
"home_page": "https://github.com/zypp-io/easyflex",
"name": "easyflex",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "python,easyflex,API",
"author": "Zypp",
"author_email": "hello@zypp.io",
"download_url": "https://files.pythonhosted.org/packages/ac/c0/68e653945f0e39a815024ec8e00665ec207a6439a6c04873f8058ad1cc8b/easyflex-0.2.1.tar.gz",
"platform": null,
"description": "<p align=\"center\"><img alt=\"logo\" src=\"https://www.zypp.io/static/assets/img/logos/zypp/black/500px.png\" width=\"200\"></p>\n<br>\n\n[](https://pepy.tech/project/easyflex)\n\n[](https://opensource.org/)\n\n# Easyflex dataservices API voor python\n> Dit project bevat python scripts voor het ontsluiten van data uit de easyflex API.\n\n## Project documentatie\n- [Introductie](#introductie)\n- [Hoe moet je dit project gebruiken?](#hoe-moet-je-dit-project-gebruiken?)\n - [Simpel voorbeeld](#simpel-voorbeeld-zonder-velden-of-parameters)\n - [Voorbeeld met parameters en velden](#voorbeeld-met-parameters-en-velden)\n\n# Introductie\nEasyflex heeft een API ontwikkeld voor het ontsluiten van data. Op basis van de [Easyflex web- en dataservices documentatie](https://confluence.easyflex.net/display/WEBDATAKLNT/Web-+en+dataservice) is dit python project ontstaan.\nHet doel van het project is om snel en efficient data te ontsluiten van 1 of meerdere Easyflex administraties.\n\n# Hoe moet je dit project gebruiken?\nIn twee stappen is het mogelijk om data te ontsluiten. De eerste stap is het initialiseren van de class `Easyflex`. In deze class registreren worden de API keys geregistreerd die gebruikt worden bij de uitvraag.\nDe tweede stap is het uitvragen van de dataservices of webservices. Hier moet een module naam worden opgegeven. Vervolgens kunnen de parameters en velden worden opgegeven, conform de [documentatie van de modules](https://confluence.easyflex.net/display/WEBDATAKLNT/1.2+ds_wm_medewerkers).\n\n### Simpel voorbeeld zonder velden of parameters\n```python\nfrom easyflex import Easyflex\napi_keys = {\"<YOUR_ADM_CODE>\": \"<YOUR_API_KEY>\",\"<YOUR_ADM_CODE_2>\": \"<YOUR_API_KEY_2>\"}\n\nef = Easyflex(api_keys, service=\"dataservice\")\ndata = ef.query(module=\"ds_wm_medewerkers\")\n```\n\n### Voorbeeld met parameters en velden\n```python\nfrom easyflex import Easyflex\napi_keys = {\"<YOUR_ADM_CODE>\": \"<YOUR_API_KEY>\",\"<YOUR_ADM_CODE_2>\": \"<YOUR_API_KEY_2>\"}\n\nef = Easyflex(api_keys, service=\"dataservice\")\ndata = ef.query(module=\"ds_wm_locaties\",\n parameters={\"status\": 21690},\n velden=[\"wm_locatie_nummer\", \"wm_locatie_code\", \"wm_locatie_naam\"])\n```\n\n## Onderhouden door:\n\n- [Zypp](https://github.com/zypp-io)\n",
"bugtrack_url": null,
"license": "",
"summary": "API connector voor het ontsluiten van data met de Easyflex API",
"version": "0.2.1",
"project_urls": {
"Bug Tracker": "https://github.com/zypp-io/easyflex/issues",
"Homepage": "https://github.com/zypp-io/easyflex",
"Source": "https://github.com/zypp-io/easyflex"
},
"split_keywords": [
"python",
"easyflex",
"api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "94cc986ea9641338f18153b2808128df5f8e76ca4119addd39f1bc9b06253097",
"md5": "319a0049c030e0ed407f36f6375c7334",
"sha256": "3bc8dd3d47049390b682e8ddc6d57069abf69ba9b26e5e595c4befd007328ae8"
},
"downloads": -1,
"filename": "easyflex-0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "319a0049c030e0ed407f36f6375c7334",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 13315,
"upload_time": "2024-01-02T09:29:07",
"upload_time_iso_8601": "2024-01-02T09:29:07.272168Z",
"url": "https://files.pythonhosted.org/packages/94/cc/986ea9641338f18153b2808128df5f8e76ca4119addd39f1bc9b06253097/easyflex-0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "acc068e653945f0e39a815024ec8e00665ec207a6439a6c04873f8058ad1cc8b",
"md5": "14272ad1ad191c8c78aa697bbe26f034",
"sha256": "bb5b697c2e50f52ef89b81b67336ed713e02c024a57579c7272c19bc7df91cf6"
},
"downloads": -1,
"filename": "easyflex-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "14272ad1ad191c8c78aa697bbe26f034",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 13295,
"upload_time": "2024-01-02T09:29:08",
"upload_time_iso_8601": "2024-01-02T09:29:08.898917Z",
"url": "https://files.pythonhosted.org/packages/ac/c0/68e653945f0e39a815024ec8e00665ec207a6439a6c04873f8058ad1cc8b/easyflex-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-02 09:29:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "zypp-io",
"github_project": "easyflex",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "easyflex"
}
JSON
