Being new to software engineering, I struggled with finding resources to understand how to make the Taggun API work. I needed to implement the Taggun API to a small project that was part of my homework submission. Taggun is a fully automated OCR Receipt Scanning Technology that can be implemented in your project. I did this with a feature of Postman.
Postman is used to make HTTP request to your application or to an api that you are working with without needing to create a form submission in HTML, this way, you can test and work on your server-code or the intended API you want to work with without coding or creating any HTML files. Additionally, Postman creates the snippet of code for you to copy and paste at the end based on what language or frameworks that you are using (will be shown below).
This step by step instructional is to help those who wishes to implement Taggun with in their project.
Signing up for a Taggun account and getting the API Key (An API key is a unique identifier that grants you access to using the API, it’s like a username and password but for your project instead).
Signing up for Taggun API Access
Step 1: Sign up for Taggun via this link
Step 2: Activate your Taggun account
Step 3: Input your credit card details to gain a 30 days trials and 50 FREE scans a month for a year
Step 4: Retrieve the API key from your email
Step 5: Read the documentation here for implementation and to understand how it all works
When I first started reading the documentation, I had no clue as to what i was doing and eventually i figured it out but it took me way longer than i needed to. As such, i decided to write a complete instructional on how to implement the API to help others that may find themselves in a similar situation.
Using the Taggun API
Step 1: Trying out the API by using the API endpoints and determine which endpoint best suits your need.
For the purpose of this example and based on what I need, I used /api/receipt/v1/verbose/file
Step 3: Import Taggun’s collection into Postman
It should look something like this:
Step 4: Select your choice of API endpoints by simplying click on the POST method that you wish to use.
In this example i used “transcribe a receipt by uploading an image file and return detailed result”.
Step 5: Click on Params and enter the API Key that you have gotten previously from Taggun
Step 6: Test if the posting to the API works on Postman to ensure that the API key works. To do so, simply click on Body and then click on Select Files and upload your receipt image
Step 7: Hit send to get the post response
This step should take awhile to process and there after you will receive the results.
Step 8: On the right hand corner, click on code and select the type of language you are using. In my case, i used NodeJS — Axios.
Step 9: Copy the code and paste it into your project.
Step 10: Install the required modules to make the API work with your project.
npm install axios form-data fs
Step 11: Integrate your project with the Taggun’s api.
I hope this article did help someone to use Taggun’s api and if the instructions are not clear enough, please feel free to contact me @ firstname.lastname@example.org. Additionally, I welcome feedback on how to make this article better. Do reach out to me! Happy Coding Everyone!
Brief introduction of me:
I’m currently a student attending Rocket Academy and I’m currently 2 months into their Software engineering 1 (SWE1 Course). Do check out Rocket Academy if you’re interested in picking up Software Engineering with some of the best instructors stemming from Stanford and who worked in some of the top companies like Facebook and Alibaba.