This documentation provides a detailed and accessible explanation of how the Vidata API works, so that everyone, from Marketing Managers to Developers, can understand and make the most of our tool.



Contents



Summary

Imagine you want to order a pizza. You could go to the pizzeria, meet the cook, tell him your preferences, wait for him to prepare it, then take it home. But that would be complicated and time-consuming, wouldn't it? Instead, you simply call the restaurant, place your order, and when it's ready, the pizza is delivered to your door. In this analogy, the API is the phone and phone number you use to place your order. The API (Application Programming Interface) is a tool that enables two pieces of software to communicate with each other in a simple, structured way.

For Vidata, this means that you can 'call' (or rather, 'send a message') us with the information you want to use to customise a video, and we'll send you back the URL of the customised video.

https://media.giphy.com/media/iJa6kOfJ3qN7a/giphy.gif

Technical dive into the Vidata API 🏊‍♀ī¸đŸ•šī¸


API Routes đŸšĻđŸ—ēī¸


Think of API routes as specific paths you can follow to access different functions of our service. For example, a route might be "order a pizza with olives". In our API, we have a number of these routes that allow you to perform different tasks, such as requesting a specific video.

Sending information via API đŸ“Ŧ🔁


When we say "you can send us your information via API", it simply means that you can use these routes to tell us what elements you want in your personalised video. It's like sending us a pizza order with the specific toppings you want.

Upload your information to an SFPT file 📂🌐


An SFPT file is a type of secure file that you can use to send us your information. This is another way of sending us your data if you don't want to use the API.