logo

Important:

This API is designed for experienced developers only and is provided as a self-service tool with minimal support.

Please be aware that currently, this API only supports legacy checkouts and classic customer accounts. It does not support integration with New Customer Accounts & new Checkout Extensibility. Shopify has not yet enabled app integration capabilities for New Customer Accounts. It is anticipated that these Shopify features will become available later in 2024. See Shopify’s consideration guide.

Fileflare API

Viewing assets

Use this API to search for assets. Optionally view connected products, too.


Search for assets

To view assets, send a GET request to:

GET https://app.digital-downloads.com/api/v1/assets

To find assets, you can add query string parameters. The results are paginated. Use the query string parameter page for more pages, or use the links provided in the response.

JSON
{
    "limit": 100, // max of 1000 will be retuned
    "filename": "My new book",
    "with_products": true, // show linked products
    "page": 5
}

Example

https://app.digital-downloads.com/api/v1/assets?limit10&filename=My%20new%20book&with_products=true&page=5

Response

JSON
{
    "data": [
        {
            "id": "82664d96-6dfd-4343-96b0-05c46f412a5b",
            "filename": "My new book",
            "size": "10MB",
            "is_file": false,
            "is_link": true,
            "url": "https://www.my-website.com/download/my-book.pdf",
            "products": [
                {
                    "id": "82664d96-6dfd-4343-96b0-05c46f412a5q",
                    "name": "My new Book",
                    "variant_name": "Paper back",
                    "sku": "my-sku",
                    "product_id": 123456,
                    "variant_id": 1234567,
                    "vendor": "my-store",
                    "tags": [
                        "books",
                        "paper-books"
                    ]
                },
                {
                    "id": "82664d96-6dfd-4343-96b0-05c46f412a5r",
                    "name": "My new Book",
                    "variant_name": "Hard back",
                    "sku": "my-sku",
                    "product_id": 123456,
                    "variant_id": 1234563,
                    "vendor": "my-store",
                    "tags": [
                        "books",
                        "hardback-books"
                    ]
                }
            ]
        }
    ],
    "links": {
        "first": "https://app.digital-downloads.com/api/v1/assets?page=1",
        "last": "https://app.digital-downloads.com/api/v1/assets?page=4",
        "prev": null,
        "next": "https://app.digital-downloads.com/api/v1/assets?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 4,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "https://app.digital-downloads.com/api/v1/assets?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": "https://app.digital-downloads.com/api/v1/assets?page=2",
                "label": "2",
                "active": false
            },
            {
                "url": "https://app.digital-downloads.com/api/v1/assets?page=3",
                "label": "3",
                "active": false
            },
            {
                "url": "https://app.digital-downloads.com/api/v1/assets?page=4",
                "label": "4",
                "active": false
            },
            {
                "url": "https://app.digital-downloads.com/api/v1/assets?page=2",
                "label": "Next »",
                "active": false
            }
        ],
        "path": "https://app.digital-downloads.com/api/v1/assets",
        "per_page": 25,
        "to": 25,
        "total": 76
    }
}

View asset

View individual assets. Optionally load linked products. Send a GET request using the assets ID.

GET https://app.digital-downloads.com/api/v1/assets/:id

Example

https://app.digital-downloads.com/api/v1/assets/82664d96-6dfd-4343-96b0-05c46f412a5b?with_products=true

Response

JSON
{
    "data": {
        "id": "82664d96-6dfd-4343-96b0-05c46f412a5b",
        "filename": "My new book",
        "size": "10MB",
        "is_file": false,
        "is_link": true,
        "url": "https://www.my-website.com/download/my-book.pdf",
        "products": [
            {
                "id": "82664d96-6dfd-4343-96b0-05c46f412a5q",
                "name": "My new Book",
                "variant_name": "Paper back",
                "sku": "my-sku",
                "product_id": 123456,
                "variant_id": 1234567,
                "vendor": "my-store",
                "tags": [
                    "books",
                    "paper-books"
                ]
            },
            {
                "id": "82664d96-6dfd-4343-96b0-05c46f412a5r",
                "name": "My new Book",
                "variant_name": "Hard back",
                "sku": "my-sku",
                "product_id": 123456,
                "variant_id": 1234563,
                "vendor": "my-store",
                "tags": [
                    "books",
                    "hardback-books"
                ]
            }
        ]
    }
}