TinEye Client Setup: Integration Guide for Developers Integrating the TinEye Commercial API allows your application to perform fast, accurate reverse image searches. This guide walks you through authenticating your client, setting up the SDK, and executing your first image match. Prerequisites
Before writing code, ensure you have the necessary account credentials and environment setup. API Account: Sign up for a TinEye Commercial API account.
API Credentials: Retrieve your unique public key and private key from your TinEye dashboard.
Development Environment: Install Python 3.7 or higher (or the corresponding runtime for your preferred language SDK). Installation
TinEye provides official client libraries for Python, Node.js, PHP, and Java. This guide uses Python for demonstration. Install the official TinEye API client using pip: pip install tineye-api Use code with caution. Authentication Mechanism
The TinEye API uses a custom HMAC-SHA256 signature algorithm to secure requests.
The client library automatically manages this signing process.
It uses your private_key to sign the request URL and your public_key to identify your account.
Never expose your private_key in client-side code or public repositories. Store it securely using environment variables. Initialize the Client
Set up your authentication keys in your application script to initialize the connection.
import os from tineye_api import TinEyeAPIRequest # Load credentials securely from environment variables PUBLIC_KEY = os.environ.get(‘TINEYE_PUBLIC_KEY’) PRIVATE_KEY = os.environ.get(‘TINEYE_PRIVATE_KEY’) # Initialize the API request client api_client = TinEyeAPIRequest(’https://tineye.com’, PUBLIC_KEY, PRIVATE_KEY) Use code with caution. Performing Image Searches
You can query the TinEye database using an image URL or by uploading a local image file directly. Option 1: Search via Image URL
Use this method when the target image is already hosted publicly on the web.
try: # Perform the search using a web URL response = api_client.search_url(url=’https://tineye.com’) # Process and print results print(f”Status: {response.status}“) print(f”Total Matches Found: {response.stats.total_results}“) except Exception as e: print(f”An error occurred: {e}“) Use code with caution. Option 2: Search via File Upload
Use this method to upload and check an image stored locally on your server or sent by a user.
try: # Open the local file in binary read mode with open(‘path/to/local_image.jpg’, ‘rb’) as image_file: response = api_client.search_data(data=image_file.read()) # Parse the JSON match collection for match in response.results: print(f”Match URL: {match.url}“) print(f”Score: {match.score}“) except FileNotFoundError: print(“The specified image file could not be found.”) except Exception as e: print(f”An error occurred: {e}“) Use code with caution. Handling the API Response
A successful TinEye API response returns a structured payload. Key properties to extract include: status: Confirms if the request succeeded (ok or warn). results: A list of matching image objects.
score: A value indicating the structural similarity of the match.
backlinks: A list of source crawl URLs where TinEye discovered the matching image online. Production Best Practices
Implement Rate Limiting: Design your application to handle API limits smoothly by queueing bursts of parallel requests.
Cache Frequent Queries: Cache the results of high-traffic images to optimize your API credit consumption.
Graceful Error Handling: Wrap API requests in robust try-catch blocks to catch network timeouts or account balance expiration issues without crashing your application workflow.
If you need help expanding this setup, let me know. I can provide code samples for other programming languages (like Node.js or Java), explain how to filter search results by specific domains, or show you how to parse detailed image backlink data.
Leave a Reply