email-assistant/parsers
Ian Fijolek aafb524673 Add pre-commit with black
No hooks are run in this commit
2020-12-11 13:06:11 -05:00
..
package-tracking Bump sinatra version since 2.0.0 is insecure 2018-03-07 13:35:52 -08:00
Makefile Add pre-commit with black 2020-12-11 13:06:11 -05:00
Readme.md Add initial indexer apis 2018-02-03 00:06:55 -08:00

parsers

A parser should conform to a simple API spec so that it can be easily accessed

Healthcheck

Simple endpoint that accepts nothing and returns 'OK' on success.

Attrs
Path /
Method GET
Response "OK"

Parse

The primary endpoint that will parse a message

Attrs
Path /parse
Method POST
Request json
Response json

Request:

Key Example Value Description
"message" "Here's your tracking number: 1Z879E930346834440" Full contents of the email message
"subject" "Your email is here" Full contents of the email message

Response:

Key Example Value Description
"token" "1Z879E930346834440" String token that was extracted
"type" "SHIPPING" A string that indicates what type of metadata that was extracted. This will be used by other services to understand what kind of data this is.
"metadata" {"carrier": "UPS"} A dictionary with any other additional metadat that may be used by other services