Documentation

API Types

Synclist has three levels of web service. On registration you can choose the one that best suits your needs and requirements.

Free API

Once registered, a confirmation email is sent to the registered email address containing the Demo API key - free of charge. This key allows users to call the Synclist database 500 times per month. Should the user require more than 500 calls per month, then the Low or High Volume API keys need to be purchased.

Low Volume API

A user can purchase the Low Volume API key for only $7.5 per month. This key allows users to call the database up to 1,000 times per month. This is set up on a recurring schedule, which will automatically debit the amount from the user's account on a monthly basis until otherwise instructed by the user.

High Volume API

The Synclist High Volume API key allows the user to make an unlimited number of calls and it costs only $15 per month. This is set up on a recurring schedule, which will automatically debit the amount from the user's account on a monthly basis until otherwise instructed by the user.

Please Note

When you upgrade to either the Low or High Volume API, your existing key will automatically be updated saving you time and allowing you to make calls immediately.

Synclist API Documentation

How to Use the API in Your System

The user can start using the API after registering on our platform. The API provides a list of titles and industries for use on your own website.

Please see the example below on how to setup the API keys in your application.

API URL:
http://www.synclist.com/demo/user/getTitle?key=aGFddyZW4ubWFrd2FuYUBwbHVzYWltLmNvbQ==
API Key: aGFddyZW4dubWFrd2FuYUBwbHVzYWltLmNvbQ==
(I) User needs to call an API URL in PHP code to get records of titles and industries.
(II) Records will be returned in a JSON format. User will get following type of JSON format:

script-img

 

The Process to integrate your API key into your website.

1) You'll need to start by creating an account on synclist.com. Once your account is created, you will receive an email with your API URLs (Included API Key) through the email address you registered during your account setup.

2) By integrating the URLs into your website, you'll get the latest job titles and industries from the synclist.com database.

3) Next, you'll want to check the process to ensure you're getting an Industry response. You can do this by checking the following code to ensure you're getting an appropriate Industry response on your website.

script-img

4) Finally, you'll want to verify the process to make sure you're receiving a Job Title response with your API key. You can do this by checking the following code to ensure you're getting an appropriate Job Title response on your website.

script-img