Hi everyone!

If you've already explored Dokky, you know it's a Suite designed for Managing, Sharing, and Selling Documents.

But perhaps you didn't know that one of its most powerful, yet perhaps least explored, Features is its set of API endpoints. Today, we want to shed some light on this aspect, showing how they can simplify the lives of Developers and open up exciting New Possibilities.

For those not in the industry, APIs are a bit like a "menu" that a Developer can use to make Dokky communicate with other Applications. Simply put, instead of having to build everything from scratch, you can use Dokky's APIs to read, write, and manage Data programmatically.


The 7 API Endpoints: What Can You Do with Dokky?

Dokky Suite provides 7 API endpoints that allow you to interact with your system. Let's see what you can do with some of them:


  1. GET /api/documents: Imagine you want to display a List of all the public Documents available on Dokky on another Website, perhaps filtering them by Category. With this endpoint, you can easily get this list and display it in a personalized way on your site.
  2. GET /api/documents/{id}: Want to display the Details of a Single Document, such as the description, price, or Author, on a dedicated page of your e-commerce site? This endpoint provides all the information you need about a specific Document.
  3. POST /api/documents: Are you creating a Mobile Application where Users can Upload Documents? This endpoint allows you to upload new files directly to Dokky via your App, without the user having to go through the Dokky web interface.
  4. POST /api/documents/{id}: Want to give your platform Users the ability to Edit the title or description of a Document they've already uploaded? With this endpoint, you can update the information of an existing document.
  5. DELETE /api/documents/{id}: If you need an Automated System to delete obsolete Documents from your Archive, this endpoint allows you to do so quickly and efficiently.
  6. GET /api/users: If your Application needs access to a list of Dokky Users, this endpoint provides the information needed to integrate, for example, with a User Management System or a reporting Application.
  7. GET /api/users/{id}: If you want to view a single User's profile Stats, this endpoint is the solution. You can use it to create custom Profile Pages on your external platform.


Practical Examples:


Integrating Dokky with Other Applications: Now that we've seen what's possible, here are some practical integration examples that might inspire you.


  1. E-commerce Sites: If you have a site based on platforms like Shopify or WooCommerce, you could use the Dokky API to automatically sync the Documents you Sell. When you upload a new document to Dokky, it can magically appear as a product on your online store.
  2. Content Management Systems (CMS): Platforms like WordPress or Joomla could use the API to display a catalog of Documents directly within their pages, perhaps with a custom user interface.
  3. Mobile Applications: App Developers can use the API to create a native User Experience for Dokky. Imagine an App that lets you upload and view your Documents directly from your smartphone.
  4. Automation Services: Services like Zapier or Make.com (formerly Integromat) could use the APIs to Create Automated Workflows. For example, you could set up a "zap" that sends a notification to Slack or an email to a specific Team every time you Upload a new Document to Dokky.
  5. Reporting and Dashboards: Companies can use the APIs to extract data from Dokky and integrate it into corporate dashboards like Microsoft Power BI or Tableau, gaining a comprehensive view of Document usage. The Dokky APIs open up a World of Possibilities for Developers and anyone who wants to extend the suite's functionality. If you have an idea, the APIs are the perfect tool to turn it into reality.


If you have questions or want to dig deeper into a specific integration, let us know! We're here to help you explore the full potential of Dokky!