This release is a pre-release and may not be stable for production use.
API.AI Webhook is a fulfillment microframework for [API.AI](https://api.ai/) based on [Flask](http://flask.pocoo.org/) for getting started quickly with API.AI [webhooks](https://docs.api.ai/docs/webhook).
## Users' Guide
### Quick Start
Install the package with
pip install apiaiwebhook
A minimal api.ai Webhook application looks like this:
from apiaiwebhook import APIAIWebhook
app = APIAIWebhook(__name__)
@app.fulfillment("hello-world")
def hello_world():
return app.make_response_apiai(speech="Hello World!")
if __name__ == '__main__':
app.run()
To run the application, just execute the python file:
python hello_world.py
To test the application, you can use either the in-built api.ai test client
app.testing = True
res = app.test_client_apiai().webhook(action="hello-world"})
assert res.status_code == 200
assert ""Hello, World!" in res.data
Or you can use curl
curl -X POST -H "Content-Type: application/json" -d '{"result": {"action": "hello-world"}}' http://127.0.0.1:5000/webhook
### Parameters
The parameters are extracted from `results/parameters`.
This dictionary is passed to the fulfillment function via `**` operator (unpacked):
{
"results": {
"action": "hello-world",
"parameters": {
"parameter": "example value"
}
}
}
The fulfillment function declaration should look like this:
@app.fulfillment("hello-world")
def hello_world(parameter = None, **kwargs):
return app.make_response_apiai(speech="Hello, %s!" % parameter)
The default value is required when the parameter can be empty.
Kwargs is useful when additional parameters are expected in the future.
### Response
The webhook dispatcher responses:
* HTTP 400 when `api_key_value` is defined but it the authentication header is not provided.
* HTTP 401 when `api_key_value` is defined but it is invalid.
* HTTP 404 when fulfillment function is not defined for the provided action.
Otherwise it returns a valid application/json content-type HTTP response.
The response can be create using the helper function of `make_response_apiai()`
Example:
@app.fulfillment("hello-world")
def my_fulfillment_none():
return app.make_response_apiai(speech="Hello, World!"
display_text="Hello, World! I am please to meet you!")
The response will be like:
{
"speech": "Hello, World!",
"displayText": "Hello, World! I am please to meet you!",
"data": None,
"contextOut": [],
"source": <name of Flask application>,
"followupEvent": None
}
### Securing
The `APIAIWebhook` class defines the initialization parameters of `api_key_header` (default is `api-key`) and `api_key_value` (default is `None`) parameters.
In order to secure your webhook, define a shared secret:
from apiaiwebhook import APIAIWebhook
app = APIAIWebhook(__name__, api_key_value="secret")
Then configure the authentication header in your API.AI agent.
### Testing
The API.AI Webhook Client extends the Flask Client in order to post valid webhook messages.
app.testing = True
app.debug = True
r = app.test_client_apiai().webhook(action="hello-world",
parameters={"param": "value"})
### Flask
The `APIAIWebhook` class is derived from `Flask`. Visit the official [website](http://flask.pocoo.org/) to extend the functionality of API.AI Webhook
## Development
Before running or deploying this application, install the framework using
[pip](http://pip.readthedocs.io/en/stable/):
pip install -e .
To test the framework, execute the unit tests via:
python unit_tests.py
Metadata
Release files for apiaiwebhook 0.1.0.dev2
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 |
|---|---|---|---|---|
| apiaiwebhook-0.1.0.dev2.tar.gz | 20.0 kB | Without provenance | Details for apiaiwebhook-0.1.0.dev2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| apiaiwebhook-0.1.0.dev2-py2.py3-none-any.whl | Python 2, Python 3 | none | any | Details for apiaiwebhook-0.1.0.dev2-py2.py3-none-any.whl |
Total release size: 42.0 kB
Release files / apiaiwebhook-0.1.0.dev2.tar.gz
| Download URL | apiaiwebhook-0.1.0.dev2.tar.gz |
|---|---|
| Size | 20.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
7496a37aa0db62eb7ec22f55b338cb926758adcf4f04dde5e495dace8d0c400f
|
|
BLAKE2b-256 checksum How to use checksums |
3cc3d21578a35adcf467d285129f4d196aab6d23cb5eb0a7ad9ce81ee286b5eb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / apiaiwebhook-0.1.0.dev2-py2.py3-none-any.whl
| Download URL | apiaiwebhook-0.1.0.dev2-py2.py3-none-any.whl |
|---|---|
| Size | 22.0 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
c6c383be8b05f52cd70ed4600104149dd152c7bf2d4a169873930909d484ea9a
|
|
BLAKE2b-256 checksum How to use checksums |
4a4d01fd576032810b1e18faa771c082f2d1f42ac5c6d75d52718061d2f25247
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for apiaiwebhook 0.1.0.dev2
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.