{"id":19528515,"url":"https://github.com/orca-scan/orca-lookup-java","last_synced_at":"2026-05-17T07:32:09.934Z","repository":{"id":39658319,"uuid":"304989786","full_name":"orca-scan/orca-lookup-java","owner":"orca-scan","description":"How to respond to an Orca Scan Lookup request using Java","archived":false,"fork":false,"pushed_at":"2022-05-28T21:44:34.000Z","size":17,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-02-25T22:55:10.542Z","etag":null,"topics":["barcode-scanning","java","smartphone","spring"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/orca-scan.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-10-17T23:52:38.000Z","updated_at":"2022-05-28T21:44:35.000Z","dependencies_parsed_at":"2022-09-07T17:23:36.570Z","dependency_job_id":null,"html_url":"https://github.com/orca-scan/orca-lookup-java","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/orca-scan%2Forca-lookup-java","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/orca-scan%2Forca-lookup-java/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/orca-scan%2Forca-lookup-java/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/orca-scan%2Forca-lookup-java/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/orca-scan","download_url":"https://codeload.github.com/orca-scan/orca-lookup-java/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240779716,"owners_count":19856240,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["barcode-scanning","java","smartphone","spring"],"created_at":"2024-11-11T01:19:07.116Z","updated_at":"2026-05-17T07:32:09.838Z","avatar_url":"https://github.com/orca-scan.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# orca-lookup-java\n\nThis 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 [Java](https://adoptopenjdk.net/?variant=openjdk8\u0026jvmVariant=hotspot) and the [spring](https://spring.io/) framework.\n\n**How it works:**\n\n1. A user [scans a barcode](https://orcascan.com/mobile) using their smartphone\n2. Orca Scan sends a HTTP GET request to your endpoint with `?barcode=value`\n3. Your system queries a database or internal API for a `barcode` match\n4. Your system returns the data in JSON format with keys matching column names\n5. The [Orca Scan mobile](https://orcascan.com/mobile) app presents that data to the user\n\n*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.*\n\n## Install\n\nFirst ensure you have [Java](https://adoptopenjdk.net/?variant=openjdk8\u0026jvmVariant=hotspot) installed:\n\n```bash\n# should return 1.7 or higher\njava -version\n```\n\nAlso ensure you have [Maven](https://maven.apache.org/download.cgi) installed:\n\n```bash\n# should return 3.8.5 or higher\nmvn -v\n```\n\nThen execute the following:\n\n```bash\n# download this example code\ngit clone https://github.com/orca-scan/orca-lookup-java.git\n\n# go into the new directory\ncd orca-lookup-java\n\n# install dependencies\nmvn install\n```\n\n## Run\n\n```bash\nmvn spring-boot:run -Dspring-boot.run.arguments=--server.port=5000\n```\n\nVisit [http://localhost:5000?barcode=4S3BMHB68B3286050](http://localhost:5000?barcode=4S3BMHB68B3286050) to see the following:\n\n```json\n{\n    \"VIN\": \"4S3BMHB68B3286050\",\n    \"Make\": \"SUBARU\",\n    \"Model\": \"Legacy\",\n    \"Manufacturer Name\": \"FUJI HEAVY INDUSTRIES U.S.A\",\n    \"Vehicle Type\": \"PASSENGER CAR\",\n    \"Year\": 1992\n}\n```\n\n## How this example works\n\n```java\n@RequestMapping(value = \"/\", method = RequestMethod.GET, produces = \"application/json\")\n@ResponseBody\npublic HashMap\u003cString, Object\u003e Lookup(String barcode) {\n\n    // TODO: query a database or API to retrieve some data based on barcode value\n\n    // return data as JSON object (property names must match Orca column names)\n    HashMap\u003cString, Object\u003e data = new HashMap\u003c\u003e();\n    data.put(\"VIN\", barcode);\n    data.put(\"Make\", \"SUBARU\");\n    data.put(\"Model\", \"Legacy\");\n    data.put(\"Manufacturer Name\", \"FUJI HEAVY INDUSTRIES U.S.A\");\n    data.put(\"Vehicle Type\", \"PASSENGER CAR\");\n    data.put(\"Year\", 1992);\n\n    return data;\n}\n```\n\n## Troubleshooting\n\nIf you run into any issues not listed here, please [open a ticket](https://github.com/orca-scan/orca-lookup-java/issues).\n\n\n## Examples in other langauges\n* [orca-lookup-node](https://github.com/orca-scan/orca-lookup-node)\n* [orca-lookup-dotnet](https://github.com/orca-scan/orca-lookup-dotnet)\n* [orca-lookup-go](https://github.com/orca-scan/orca-lookup-go)\n* [orca-lookup-python](https://github.com/orca-scan/orca-lookup-python)\n* [orca-lookup-php](https://github.com/orca-scan/orca-lookup-php)\n\n## History\n\nFor change-log, check [releases](https://github.com/orca-scan/orca-lookup-java/releases).\n\n## License\n\nLicensed under [MIT License](LICENSE) \u0026copy; Orca Scan, the [Barcode Scanner app for iOS and Android](https://orcascan.com).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Forca-scan%2Forca-lookup-java","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Forca-scan%2Forca-lookup-java","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Forca-scan%2Forca-lookup-java/lists"}