Overview

Welcome to the Sync Web API! This API follows the RESTful architecture, allowing you to interact with it through HTTP requests from any programming language.

The reference guide serves as a comprehensive resource on utilizing the API to retrieve vehicle debts and other pertinent information from multiple country government websites. Organized by Sync objects, each representing a specific component of the Sync system, such as statuses, states, or resources, the guide offers detailed instructions.

For every Sync object, the guide presents one or more data representations, with objects represented in JSON format. Additionally, it outlines the supported methods, primarily focusing on the GET method, and provides clear explanations on how to employ these methods effectively.

About The Sync API

The API provides quick and easy access to a wide range of vehicle information, including fines, ownership taxes, renewals, theft reports, and more. These up-to-date data are directly obtained from the relevant government websites, ensuring accuracy and reliability. With our API, you can effortlessly access this valuable vehicle information, enabling you to make informed decisions and stay updated on the status and history of any vehicle.

To retrieve this information, the vehicle must have been processed in one of the Sync resources. Sending a vehicle for processing involves providing the license plate and VIN, along with specifying the desired resource for processing, such as "Fines Aguascalientes" or "Ownership Taxes Coahuila." Once the vehicle has been successfully processed in the chosen resource, you can access comprehensive details regarding fines, ownership taxes, and other relevant information through our API.

In addition, our API offers a unique feature that enables you to retrieve the state associated with a vehicle's license plate. Leveraging official standards like the NOM-001-SCT-2-2016, we accurately determine the state based on the specific license plate pattern. With a simple input of the license plate number, you can effortlessly access the corresponding state information.

info

At the moment, the functionality to send vehicles for processing cannot be performed directly through the API. To initiate the processing of vehicles, you can utilize Sync platform. Once the vehicle has been successfully processed, you can use the API to retrieve the processing results or view them within the Sync platform.

Base URL

All URLs referenced in the API documentation have the following base:

https://api-sync-resser.azurewebsites.net/

Authentication

The Sync API uses API keys for authentication. Please get in touch with Resser Industries to get the API key that you will be using for your requests.

To use keys, you must set a plain text header named apiKey with the contents of the header being your API Secret Key. All API requests should include your API key in an HTTP header as follows:

apiKey: $SYNC_API_KEY

Remember that your API key is a secret!

Do not share it with others or expose it in any client-side code (browsers, apps). Production requests must be routed through your own backend server where your API key can be securely loaded from an environment variable or key management service.

Making Requests

You can paste the command below into your terminal to run your first API request. Make sure to replace $SYNC_API_KEY with your secret API key.

curl https://api-sync-resser.azurewebsites.net/api/test \
  -H "apiKey: $SYNC_API_KEY"

Yo will get a response like this

{
    message: 'Hello from Sync API';
}

Objects

An object is an individual data entity that Sync API uses to work with the data. The table below describes the different types of objects that you can interact with using the Sync API.

Objects	Description
Country	Represents a country available in Sync. It includes general country information (such as ID, key, and code).
CriteriaType	Defines the type of criteria available in Sync. Each criteria type determines what input data (e.g., plate, VIN, tax identifier) is required to query vehicle information. Some criteria retrieve a single vehicle (e.g., plate or VIN), while others retrieve multiple vehicles (e.g., tax identifier).
Health	Contains relevant information about the current connection of Sync to the resource webpages based on the last 100 processed vehicles per resource.
Resource	Represents a resource that is available in Sync. A resource is where a vehicle can be processed to obtain vehicle-related details, depending on the specific resource it is processed in.
ResourceType	Represents a resource type that is available in Sync. A resource type indicates the different types of information that Sync can obtain from a vehicle, and each resource in Sync is always associated with a specific resource type
Scraped	Represents the result of a vehicle processing. The contents of this object can vary depending on the resource type on which the vehicle has been processed.
State	Represents a state that is available in Sync.
Status	Represents a status that a process vehicle can have in Sync. A status can be unproccessed, without fines, with stolen reports, etc.
TaxIdentity	Contains the tax identification information that Sync knows (or is provided) about an entity. Some resources require a tax identifier or legal name to process requests in government portals or websites. This object centralizes that data, ensuring Sync can successfully process resources that require tax identity details.
VehicleInfo	Represents the information of a vehicle that is available in Sync.