Migrating from MobileEngine¶

If you are moving from MobileEngine to WineEngine, here’s what you need to know:

• Images should be 1000px on the smaller side for both query and collection images.

• We will return the vintage and variety read from the mobile photo label. It is optional for you to make use of this, but we would recommend it!

• For the sake of completeness, we also return the vintage and variety read from the label in your collection in the POST search response.

• We send bounding boxes for label area, vintage area and variety area in photos.

Requirements¶

Using the WineEngine API requires basic programming skills, in particular sending and receiving HTTP requests and responses to a REST interface and reading the results in JSON or XML format. For production environments we highly recommend using servers with static IP addresses so you can take advantage of our IP based security.

Outline¶

Implementation of the WineEngine API involves the following steps:

1. Provide us with the static IP addresses of your server(s) (recommended)

2. Read the API documentation

3. Write code to call the API

Providing your IP addresses (recommended)¶

Our basic authentication method is password-based. However, if you provide us with your server’s IP addresses, we can replace the password-based authentication with IP-based authentication for increased security.

We will remove the password-based authentication when the IP authentication system is in place, and you can always edit the IP addresses associated with your API account through your dashboard.

If you are unsure of your IP addresses, run the following from your server:

curl http://ifconfig.me/ip

That command will return your IP address, which will be four numbers separated by periods, such as 192.0.43.10.

Reading the API documentation¶

Make sure to go over the API documentation before you begin writing code. Some parameters are optional and some can potentially slow down your searches.

The documentation also includes additional information such as supported image types and API method limitations.

You can also try out the API methods interactively using the interactive API Explorer.

Writing code to call the API¶

Once all preparations are complete, write the code to call the API. Make sure your code calls our API from a server-side script. Calling the API from your users’ client prevents the use of the more secure IP authentication and exposes your password, allowing anyone to delete your images or add their own.

Once you’ve set up your API, you can add some images to your collection in the next tutorial: Adding images.