arzt.shopping

This repo contains description of the arzt.shopping API to read orders via REST. You may also integrate with arzt-shopping importing PDFs which is documented here.

arzt.shopping API

Endpoint to read orders from arzt.shopping. After you have registered your location you are eligable to
receive an API key to retrieve orders via JSON/REST for integration purposes. Only a registered medical doctor is eligable for an API key - data is restricted to its own private practice. We need an IP address (or range), the consensus of the practice and we wil provide an API key.

Useful links

• API documentation
• Sample Response Json

Test the API

Test with Demo data - select "Testarzt (für Softwarehersteller)" on in the shopping cart of arzt.shopping to experiment wich the interface.

curl  https://europe-west6-cash36-prod-262508.cloudfunctions.net/testOrders?start_date=2023-03-01 \
-H "x-api-key: demo" \
-H "Content-Type: application/json"

Generate documentation with openapi generator- you may change ´-g html´ with ´-g html2´ or other targets.

openapi-generator-cli generate -i api-spec.yaml -g html -o docs --generate-alias-as-model -config openapi-html-config.json

Alternatively generate docu with redoc:

npm run generate-docs
npm run deploy-docs

Useful links for development

OpenAPI generator OpenAPI Html generator Schema generator

arzt.shopping Webhook

Please contact us to provide the endpoint for your hook. We submit an array with one order using the schema above for each order.

arzt.shopping CSV or File export

Please contact us for other integration patterns.