Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tabscanner Receipt OCR (Independent Publisher) #3756

Open
wants to merge 6 commits into
base: dev
Choose a base branch
from
Open

Tabscanner Receipt OCR (Independent Publisher) #3756

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
401089e
adds files for Tabscanner connector
Jan 15, 2025
9d721d0
updates metadata
Jan 15, 2025
9f3b3f3
Delete independent-publisher-connectors/.DS_Store
tokyoben Jan 22, 2025
3d3bba3
correct file struture
Jan 22, 2025
32d65ce
Merge branch 'feature/tabscanner-receipt-ocr' of github.com:tokyoben/…
Jan 22, 2025
de00d74
corrects readme description, shortens parameter descriptions and upda…
Feb 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
213 changes: 213 additions & 0 deletions independent-publisher-connectors/Tabscanner Receipt OCR/apiDefinition.swagger.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,213 @@
{
"swagger": "2.0",
"info": {
"title": "Tabscanner Receipt OCR",
"version": "1.0.0",
"description": "The Tabscanner API provides powerful Optical Character Recognition (OCR) technology to extract structured data from images of receipts with high accuracy.\nDesigned for developers and businesses, this API simplifies the process of digitizing receipts, enabling seamless integration with financial systems, expense tracking platforms, and data analytics solutions.\n",
"contact": {
"name": "Ben Smith",
"url": "https://github.com/tokyoben",
"email": "[email protected]"
}
},
"host": "api3.tabscanner.com",
"basePath": "/",
"schemes": [
"https"
],
"paths": {
"/api/2/processbase64": {
"post": {
"tags": [
"default"
],
"summary": "Submit a receipt for processing",
"description": "Submit JSON data to the Tabscanner system.",
"operationId": "Process",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"type": "object",
"properties": {
"image": {
"type": "string",
"description": "Base64-encoded receipt image. Can accept JPG and PNG file formats.",
"example": "data:image/jpeg;base64,/9j/4AAQ..."
},
"region": {
"type": "string",
"description": "The 2-alpha ISO country code of the supported country.",
"example": "hk"
},
"documentType": {
"type": "string",
"description": "Accepts a string value. Must be receipt, invoice or auto.",
"example": "receipt"
},
"defaultDateParsing": {
"type": "string",
"description": "Accepts a string value. Must be m/d or d/m.",
"example": "m/d"
},
"decimalPlaces": {
"type": "string",
"description": "Accepts an integer value should be 0, 1 or 3.",
"example": 2
}
}
}
}
],
"responses": {
"200": {
"description": "Successful response",
"schema": {
"$ref": "#/definitions/Process"
}
}
}
}
},
"/api/result/{token}": {
"get": {
"tags": [
"default"
],
"summary": "Retrieve the result of a receipt image submitted for processing",
"description": "This operation returns the result of the processed receipt image.",
"operationId": "Result",
"produces": [
"application/json"
],
"parameters": [
{
"name": "token",
"in": "path",
"required": true,
"type": "string",
"description": "Unique token to identify the processing request."
}
],
"responses": {
"200": {
"description": "Successful response",
"schema": {
"$ref": "#/definitions/Result"
}
}
}
}
}
},
"definitions": {
"Process": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "SUCCESS: Image uploaded successfully"
},
"status": {
"type": "string",
"example": "success"
},
"status_code": {
"type": "integer",
"format": "int32",
"example": 2
},
"token": {
"type": "string",
"example": "WdoHFx2fojq9b0Qd"
},
"success": {
"type": "boolean",
"example": true
},
"code": {
"type": "integer",
"format": "int32",
"example": 200
},
"duplicate": {
"type": "boolean",
"example": true
},
"duplicateToken": {
"type": "string",
"example": "kV96aAhXeuE8iDkO"
}
}
},
"Result": {
"type": "object",
"properties": {
"URL": {
"type": "string",
"example": "TARGET.COM"
},
"tax": {
"type": "integer",
"format": "int32",
"example": 0
},
"tip": {
"type": "integer",
"format": "int32",
"example": 0
},
"url": {
"type": "string",
"example": "target.com"
},
"total": {
"type": "number",
"example": 28.1
},
"address": {
"type": "string",
"example": "West Hollywood, Santa Monica Blvd, West Hollywood, CA 90046"
},
"date": {
"type": "string",
"format": "date-time"
}
}
}
},
"securityDefinitions": {
"api_key": {
"type": "apiKey",
"in": "header",
"name": "apikey"
}
},
"security": [
{
"api_key": []
}
],
"x-ms-connector-metadata": [
{
"propertyName": "Website",
"propertyValue": "https://www.tabscanner.com"
},
{
"propertyName": "Privacy policy",
"propertyValue": "https://tabscanner.com/privacy-policy/"
},
{
"propertyName": "Categories",
"propertyValue": "Data;Productivity"
}
]
}
23 changes: 23 additions & 0 deletions independent-publisher-connectors/Tabscanner Receipt OCR/apiProperties.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"properties": {
"connectionParameters": {
"apikey": {
"type": "securestring",
"uiDefinition": {
"displayName": "API Key",
"description": "The API Key for this api",
"tooltip": "Provide your API Key",
"constraints": {
"required": "true"
}
}
}
},
"iconBrandColor": "#da3b01",
"capabilities": [
"actions"
],
"publisher": "Ben Smith",
"stackOwner": "Tabscanner"
}
}
20 changes: 20 additions & 0 deletions independent-publisher-connectors/Tabscanner Receipt OCR/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Tabscanner Receipt OCR
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please refer the below link and update/add all the required sections.

https://github.com/microsoft/PowerPlatformConnectors/blob/dev/templates/Independent%20Publisher/readme.md

The Tabscanner API service processes an image of a receipt and returns the extracted data.

## Publisher: Ben Smith

## Prerequisites
An API Key is Required. Please create an account at [Tabscanner](https://tabscanner.com) to get your API key.​

## Supported Operations
### Submit a receipt image for processing
Upload a receipt image in base64 format for transcription.

### Retrieve the result of a processed receipt image
The result contains the receipt transcription.

## Obtaining Credentials
An API Key is Required. Please create an account at [Tabscanner](https://tabscanner.com) to get your API key.​

## Known Issues and Limitations
No known issues and limitations.