Overview
An Application Programming Interface (API) is a set of protocols, routines, and tools for building software applications. Most commonly, APIs act as a bridge between the two software programs, enabling them to exchange information and work together seamlessly.
Think of an API as a waiter at a restaurant, moving between the customer and the chef.
To use the Syndigo API, customers must first obtain an API key from Syndigo, which allows them to authenticate and access the API. They can then make HTTP requests to the API using various programming languages and tools, such as Python, Java, or cURL.
Pulling Data
The Syndigo API provides a set of standardized endpoints that customers can use to access product information stored in the Syndigo database. Customers can use the API to retrieve information about products such as their descriptions, images, nutritional information, and more. Once retrieved, the customer can integrate this product content into their own applications, such as e-commerce websites and mobile apps.
The Syndigo API supports a variety of query parameters and filters, which allow developers to retrieve only the specific product information they need. The API also provides pagination support, so developers can retrieve large amounts of product data in manageable chunks.
Example of API data pull:
Pushing Data
In addition to using the Syndigo API to pull data from Syndigo, customers also have the ability to push data, such as products and assets, to Syndigo, potentially reducing time required in the Syndigo Platform. If desired, customers can also use the API to categorize products and add recipient links, as well as manage data quality, publishing processes, and recipient feedback.
Before pushing data to the Syndigo platform, customers must choose the level of functionality to be managed by the API, map their source attributes to the necessary Syndigo attributes, and build and format the payload to meet the API standards. Once implemented, the API will need to be updated by the customer as recipients update their requirements.
Example of API data push:
Feedback Requests
Once a product has been published to a recipient from the Syndigo platform, the product’s publication status and recipient feedback (where applicable) may also be pulled using Syndigo API. This information is used to inform the user of required or suggested changes to the product data and can be essential in ensuring a product is successfully delivered.
Example of API feedback request:
