Quickstart Guide
Welcome to the Scanily API! This guide will help you integrate our shipping label recognition technology into your application in less than 5 minutes.
tips_and_updates
Before you begin
Make sure you have your API_KEY ready from your Dashboard. You'll need it to authenticate your requests.
1. Authentication
All API requests must include your API Key in the Authorization HTTP header.
2. Make your first request
Send a POST request to the /v1/scan endpoint with a URL of a shipping label image.
curl -X POST https://api.scanily.com/v1/scan \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json"\ -d '{
"image_url": "https://example.com/label.jpg",
"carrier_detection": true
}'3. Handling the response
The API will return a JSON object containing the parsed fields like tracking number, carrier, sender, and recipient details.
Response
{
"id": "scan_8f92j2k0l",
"status": "success",
"data": {
"tracking_number": "1Z9999999999999999",
"carrier": "UPS",
"service_type": "Ground",
"weight": "2.5 lbs"
}
}