Before you begin to use the MatchEngine API, make sure you have the following:
- Basic programming skills (REST, JSON or XML, HTTP request and responses)
- A server with a static IP
Implementation of the MatchEngine API involves the following steps:
- Provide us with the static IP addresses of your server(s) (recommended)
- Read the API documentation
- 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 address, run the following from your server:
$ curl http://ifconfig.me/ip 126.96.36.199
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 is also a good place to find additional information on the API such as supported image types and API method limitations.
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 would expose your password, and allow anyone to delete your images or add their own. It would also prevent the use of the more secure IP authentication.