snelnotuleren-sdk


Namesnelnotuleren-sdk JSON
Version 1.1.6 PyPI version JSON
download
home_pagehttps://github.com/snelnotuleren/python-sdk
SummaryPython SDK voor de Snelnotuleren.nl API
upload_time2025-02-22 22:38:28
maintainerNone
docs_urlNone
authorSnelnotuleren.nl
requires_python>=3.7
licenseNone
keywords notulen transcriptie api webhook
VCS
bugtrack_url
requirements requests
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Snelnotuleren Python SDK
[![PyPI version](https://badge.fury.io/py/snelnotuleren-sdk.svg)](https://badge.fury.io/py/snelnotuleren-sdk)
[![Python versions](https://img.shields.io/pypi/pyversions/snelnotuleren-sdk.svg)](https://pypi.org/project/snelnotuleren-sdk/)

Python SDK voor de Snelnotuleren.nl API. Automatiseer het verwerken van audio-opnames naar notulen.

## Installatie

```bash
pip install snelnotuleren-sdk
```

## Gebruik

### API Credentials aanmaken
Je kunt op twee manieren API credentials krijgen:

1. Via het dashboard op [dashboard.snelnotuleren.nl](https://dashboard.snelnotuleren.nl)
2. Programmatisch via de SDK:

```python
from snelnotuleren import SnelNotulerenClient

# Maak nieuwe credentials aan
client = SnelNotulerenClient()
credentials = client.create_client_credentials(
    label="Mijn API Client",
    description="Voor automatische verwerking"
)

print(f"Client ID: {credentials['client_id']}")
print(f"Client Secret: {credentials['client_secret']}")
print(f"Webhook Secret: {credentials['webhook_secret']}")  # Voor webhook verificatie
```

### Notulen verwerken

```python
from snelnotuleren import SnelNotulerenClient

# Initialiseer met je credentials
client = SnelNotulerenClient(
    client_id='jouw_client_id',
    client_secret='jouw_client_secret'
)

# Maak een order aan
order_id = client.create_order(
    file_path='vergadering.mp3',
    email='contact@bedrijf.nl',
    context='Maandelijkse vergadering',
    report_type='middel_notulen',  # Optional, standaard op transcriptie
    speaker_diarization=True,      # Optional, experimenteel
    speaker_count=4                # Optional, experimenteel
)
```

### Webhook Notificaties

Je kunt webhooks gebruiken om direct een notificatie te krijgen wanneer je notulen klaar zijn:

```python
# Maak een order met webhook URL
order_id = client.create_order(
    file_path='vergadering.mp3',
    email='contact@bedrijf.nl',
    context='Maandelijkse vergadering',
    webhook_url='https://jouw-domein.nl/webhook'
)
```

Implementeer een webhook handler:

```python
from flask import Flask, request
import hmac
import hashlib

app = Flask(__name__)

@app.route('/webhook', methods=['POST'])
def webhook():
    # Verifieer de webhook signature
    signature = request.headers.get('X-Webhook-Signature')
    payload = request.get_data().decode('utf-8')
    
    expected_signature = hmac.new(
        'jouw_webhook_secret'.encode(),  # Van je credentials
        payload.encode(),
        hashlib.sha256
    ).hexdigest()
    
    if signature != expected_signature:
        return 'Invalid signature', 401

    # Verwerk de webhook
    data = request.json
    
    if data['event'] == 'processing.completed':
        # Notulen zijn klaar
        notulen = data['data']['notulen']
        print(f"✅ Notulen ontvangen voor order {data['order_id']}")
        
    elif data['event'] == 'processing.failed':
        print(f"❌ Error voor order {data['order_id']}: {data['error']}")
    
    return 'OK', 200

if __name__ == '__main__':
    app.run(port=8080)
```

## Webhook Events

Je kunt deze events verwachten:

- `processing.completed`: Notulen zijn succesvol verwerkt
  ```json
  {
    "event": "processing.completed",
    "order_id": "order_123",
    "status": "completed",
    "data": {
      "meeting_name": "Maandelijkse vergadering",
      "meeting_date": "2024-02-22",
      "notulen": "Agendapunt 1: Opening\n De vergadering wordt geopend...",
      "speakers": ["Spreker 1", "Spreker 2"],
      "metadata": {
        "speaker_diarization": true,
        "speakers_expected": 2,
        "detected_language": "nl",
        "categories": ["Opening", "Rondvraag"]
      }
    }
  }
  ```

- `processing.failed`: Er is een fout opgetreden
  ```json
  {
    "event": "processing.failed",
    "order_id": "order_123",
    "status": "failed",
    "error": "Beschrijving van de fout"
  }
  ```

## Report Types

- `transcriptie`: Alleen transcriptie
- `korte_notulen`: Beknopte notulen
- `middel_notulen`: Uitgebreide notulen
- `lange_notulen`: Complete notulen met details

## Security Best Practices

1. Bewaar je client secret en webhook secret veilig
2. Verifieer altijd de webhook signature
3. Gebruik HTTPS voor je webhook endpoint
4. Implementeer rate limiting op je webhook endpoint

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/snelnotuleren/python-sdk",
    "name": "snelnotuleren-sdk",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": null,
    "keywords": "notulen, transcriptie, api, webhook",
    "author": "Snelnotuleren.nl",
    "author_email": "niels@snelnotuleren.nl",
    "download_url": "https://files.pythonhosted.org/packages/cf/17/c561ba634c6520c033ac605047369e31ebf5a6b9616cc7fa80aa8575310d/snelnotuleren-sdk-1.1.6.tar.gz",
    "platform": null,
    "description": "# Snelnotuleren Python SDK\n[![PyPI version](https://badge.fury.io/py/snelnotuleren-sdk.svg)](https://badge.fury.io/py/snelnotuleren-sdk)\n[![Python versions](https://img.shields.io/pypi/pyversions/snelnotuleren-sdk.svg)](https://pypi.org/project/snelnotuleren-sdk/)\n\nPython SDK voor de Snelnotuleren.nl API. Automatiseer het verwerken van audio-opnames naar notulen.\n\n## Installatie\n\n```bash\npip install snelnotuleren-sdk\n```\n\n## Gebruik\n\n### API Credentials aanmaken\nJe kunt op twee manieren API credentials krijgen:\n\n1. Via het dashboard op [dashboard.snelnotuleren.nl](https://dashboard.snelnotuleren.nl)\n2. Programmatisch via de SDK:\n\n```python\nfrom snelnotuleren import SnelNotulerenClient\n\n# Maak nieuwe credentials aan\nclient = SnelNotulerenClient()\ncredentials = client.create_client_credentials(\n    label=\"Mijn API Client\",\n    description=\"Voor automatische verwerking\"\n)\n\nprint(f\"Client ID: {credentials['client_id']}\")\nprint(f\"Client Secret: {credentials['client_secret']}\")\nprint(f\"Webhook Secret: {credentials['webhook_secret']}\")  # Voor webhook verificatie\n```\n\n### Notulen verwerken\n\n```python\nfrom snelnotuleren import SnelNotulerenClient\n\n# Initialiseer met je credentials\nclient = SnelNotulerenClient(\n    client_id='jouw_client_id',\n    client_secret='jouw_client_secret'\n)\n\n# Maak een order aan\norder_id = client.create_order(\n    file_path='vergadering.mp3',\n    email='contact@bedrijf.nl',\n    context='Maandelijkse vergadering',\n    report_type='middel_notulen',  # Optional, standaard op transcriptie\n    speaker_diarization=True,      # Optional, experimenteel\n    speaker_count=4                # Optional, experimenteel\n)\n```\n\n### Webhook Notificaties\n\nJe kunt webhooks gebruiken om direct een notificatie te krijgen wanneer je notulen klaar zijn:\n\n```python\n# Maak een order met webhook URL\norder_id = client.create_order(\n    file_path='vergadering.mp3',\n    email='contact@bedrijf.nl',\n    context='Maandelijkse vergadering',\n    webhook_url='https://jouw-domein.nl/webhook'\n)\n```\n\nImplementeer een webhook handler:\n\n```python\nfrom flask import Flask, request\nimport hmac\nimport hashlib\n\napp = Flask(__name__)\n\n@app.route('/webhook', methods=['POST'])\ndef webhook():\n    # Verifieer de webhook signature\n    signature = request.headers.get('X-Webhook-Signature')\n    payload = request.get_data().decode('utf-8')\n    \n    expected_signature = hmac.new(\n        'jouw_webhook_secret'.encode(),  # Van je credentials\n        payload.encode(),\n        hashlib.sha256\n    ).hexdigest()\n    \n    if signature != expected_signature:\n        return 'Invalid signature', 401\n\n    # Verwerk de webhook\n    data = request.json\n    \n    if data['event'] == 'processing.completed':\n        # Notulen zijn klaar\n        notulen = data['data']['notulen']\n        print(f\"\u2705 Notulen ontvangen voor order {data['order_id']}\")\n        \n    elif data['event'] == 'processing.failed':\n        print(f\"\u274c Error voor order {data['order_id']}: {data['error']}\")\n    \n    return 'OK', 200\n\nif __name__ == '__main__':\n    app.run(port=8080)\n```\n\n## Webhook Events\n\nJe kunt deze events verwachten:\n\n- `processing.completed`: Notulen zijn succesvol verwerkt\n  ```json\n  {\n    \"event\": \"processing.completed\",\n    \"order_id\": \"order_123\",\n    \"status\": \"completed\",\n    \"data\": {\n      \"meeting_name\": \"Maandelijkse vergadering\",\n      \"meeting_date\": \"2024-02-22\",\n      \"notulen\": \"Agendapunt 1: Opening\\n De vergadering wordt geopend...\",\n      \"speakers\": [\"Spreker 1\", \"Spreker 2\"],\n      \"metadata\": {\n        \"speaker_diarization\": true,\n        \"speakers_expected\": 2,\n        \"detected_language\": \"nl\",\n        \"categories\": [\"Opening\", \"Rondvraag\"]\n      }\n    }\n  }\n  ```\n\n- `processing.failed`: Er is een fout opgetreden\n  ```json\n  {\n    \"event\": \"processing.failed\",\n    \"order_id\": \"order_123\",\n    \"status\": \"failed\",\n    \"error\": \"Beschrijving van de fout\"\n  }\n  ```\n\n## Report Types\n\n- `transcriptie`: Alleen transcriptie\n- `korte_notulen`: Beknopte notulen\n- `middel_notulen`: Uitgebreide notulen\n- `lange_notulen`: Complete notulen met details\n\n## Security Best Practices\n\n1. Bewaar je client secret en webhook secret veilig\n2. Verifieer altijd de webhook signature\n3. Gebruik HTTPS voor je webhook endpoint\n4. Implementeer rate limiting op je webhook endpoint\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Python SDK voor de Snelnotuleren.nl API",
    "version": "1.1.6",
    "project_urls": {
        "Homepage": "https://github.com/snelnotuleren/python-sdk"
    },
    "split_keywords": [
        "notulen",
        " transcriptie",
        " api",
        " webhook"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a87805b577210eedd9facac1e58ec6da8bc98c68b214026ff832c8603eee5a05",
                "md5": "95b81b07098911cd07b2661986415918",
                "sha256": "13753cef09f4f20115f224933ff243c7cfddda7297589d83df3e27db2ac9ecda"
            },
            "downloads": -1,
            "filename": "snelnotuleren_sdk-1.1.6-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "95b81b07098911cd07b2661986415918",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 6407,
            "upload_time": "2025-02-22T22:38:26",
            "upload_time_iso_8601": "2025-02-22T22:38:26.319325Z",
            "url": "https://files.pythonhosted.org/packages/a8/78/05b577210eedd9facac1e58ec6da8bc98c68b214026ff832c8603eee5a05/snelnotuleren_sdk-1.1.6-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "cf17c561ba634c6520c033ac605047369e31ebf5a6b9616cc7fa80aa8575310d",
                "md5": "c132d6ec316cb953f74c93aa77baa409",
                "sha256": "970577b7644866f3d8f436416c14431756c73488541a3b24cf2152c89ec8a81d"
            },
            "downloads": -1,
            "filename": "snelnotuleren-sdk-1.1.6.tar.gz",
            "has_sig": false,
            "md5_digest": "c132d6ec316cb953f74c93aa77baa409",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 6042,
            "upload_time": "2025-02-22T22:38:28",
            "upload_time_iso_8601": "2025-02-22T22:38:28.236211Z",
            "url": "https://files.pythonhosted.org/packages/cf/17/c561ba634c6520c033ac605047369e31ebf5a6b9616cc7fa80aa8575310d/snelnotuleren-sdk-1.1.6.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-02-22 22:38:28",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "snelnotuleren",
    "github_project": "python-sdk",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [
        {
            "name": "requests",
            "specs": [
                [
                    ">=",
                    "2.25.0"
                ]
            ]
        }
    ],
    "lcname": "snelnotuleren-sdk"
}
        
Elapsed time: 0.49853s