https://github.com/orca-scan/orca-lookup-go
How to respond to an Orca Scan Lookup request using Go
https://github.com/orca-scan/orca-lookup-go
barcode-scanning go smartphone
Last synced: 1 day ago
JSON representation
How to respond to an Orca Scan Lookup request using Go
- Host: GitHub
- URL: https://github.com/orca-scan/orca-lookup-go
- Owner: orca-scan
- License: mit
- Created: 2020-10-17T16:43:43.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2022-05-28T21:45:00.000Z (over 3 years ago)
- Last Synced: 2025-02-25T22:55:10.585Z (7 months ago)
- Topics: barcode-scanning, go, smartphone
- Language: Go
- Homepage:
- Size: 18.6 KB
- Stars: 1
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# orca-lookup-go
This open source project is a an example of [how to scan barcodes using a smartphone](https://orcascan.com/mobile) and [present data from your system](https://orcascan.com/docs/api/lookup-url) using [Go](https://golang.org/) and the [gin](https://github.com/gin-gonic/gin) framework.
**How it works:**
1. A user [scans a barcode](https://orcascan.com/mobile) using their smartphone
2. Orca Scan sends a HTTP GET request to your endpoint with `?barcode=value`
3. Your system queries a database or internal API for a `barcode` match
4. Your system returns the data in JSON format with keys matching column names
5. The [Orca Scan mobile](https://orcascan.com/mobile) app presents that data to the user
*If the mobile user has [update permission](https://orcascan.com/docs/getting-started/adding-users#selecting-user-permissions) and saves the data, it will saved to your Orca sheet.*
## Install
First ensure you have [Go](https://golang.org/dl/) installed:
```bash
# should return 1.13 or higher
go version
```
Then execute the following:
```bash
# download this example code
git clone https://github.com/orca-scan/orca-lookup-go.git
# go into the new directory
cd orca-lookup-go
# install dependencies
go get -d ./...
```
If you get an error from this command like "`go.mod file not found in current directory or any parent directory.`", enter the following command, then try again:
```bash
go env -w GO111MODULE=auto
```
## Run
```bash
# start the project
go run main.go
```
Visit [http://localhost:5000?barcode=4S3BMHB68B3286050](http://localhost:5000?barcode=4S3BMHB68B3286050) to see the following:
```json
{
"VIN": "4S3BMHB68B3286050",
"Make": "SUBARU",
"Model": "Legacy",
"Manufacturer Name": "FUJI HEAVY INDUSTRIES U.S.A",
"Vehicle Type": "PASSENGER CAR",
"Year": 1992
}
```
## How this example works
This [simple example](main.go) uses the [gin](https://github.com/gin-gonic/gin) framework:
```go
// GET / handler
router.GET("/", func(c *gin.Context) {
// get the incoming barcode sent from Orca Scan (scanned by a user)
barcode := c.Query("barcode")
// TODO: query a database or API to retrieve some data based on barcode value
// return data as JSON object (property names must match Orca column names)
c.JSON(200, gin.H{
"VIN": barcode,
"Make": "SUBARU",
"Model": "Legacy",
"Manufacturer Name": "FUJI HEAVY INDUSTRIES U.S.A",
"Vehicle Type": "PASSENGER CAR",
"Year": 1992,
})
})
```
## Troubleshooting
If you run into any issues not listed here, please [open a ticket](https://github.com/orca-scan/orca-lookup-go/issues).
## Examples in other langauges
* [orca-lookup-node](https://github.com/orca-scan/orca-lookup-node)
* [orca-lookup-dotnet](https://github.com/orca-scan/orca-lookup-dotnet)
* [orca-lookup-python](https://github.com/orca-scan/orca-lookup-python)
* [orca-lookup-php](https://github.com/orca-scan/orca-lookup-php)
* [orca-lookup-java](https://github.com/orca-scan/orca-lookup-java)
## History
For change-log, check [releases](https://github.com/orca-scan/orca-lookup-go/releases).
## License
Licensed under [MIT License](LICENSE) © Orca Scan, the [Barcode Scanner app for iOS and Android](https://orcascan.com).