Including an API to StackSync will provide us with many benefits. Otherwise, the access to the StackSync system would be limited to our only desktop client. The only way a user could access their content is installing our application on its computer and synchronize its whole repository, which could take some time depending on the amount of files.
By creating an API we pretend to have a wider reach and allow a third-parties to create new presentation layers like an application, a website, or a widget that interacts with the StackSync system. Therefore, an API is meant to distribute services and information to new audiences that can be customized to provide a new user experience.
Furthermore, an API would also allow StackSync content to be integrated or embedded with other services or applications. Thus, ensuring a smooth and integrated user experience, and relevant and up-to-date information, for the user. The information is delivered wherever it can be useful to them. In addition, as everything is changing so quickly, an API would help us to support unanticipated future uses. Making data available via API can support faster and easier data migration and improved data quality review and cleanup.All in all, an API provides a set of benefits, some of them are not even expected, that would increase the value of our product.
Next we will provide explain how the API should be built and what requirements have to be met.