This is the documentation for 2022-02-01.

Logos

Here you can view logos, design a logo or create a new one with a new file or an uploaded media (See Upload Media).

Designing and Creating Logos requires long-lasting file operations. After transferring and creating files you will receive a new Logo that can be placed on a variant. See Design variant.

List

Returns a collection of Logos

Filtering

You can filter your results as follows:

List logos for specified id(s)

/logos?filter[id]=1
/logos?filter[id]=1,2,3

List logos for specified production method handle(s)

/logos?filter[production_method.handle]=dtg
/logos?filter[production_method.handle]=dtg,embroidery

List logos for specified production method id(s)

/logos?filter[production_method.id]=1
/logos?filter[production_method.id]=1,2,3

List logos for specified production collection names(s)

/logos?filter[collection_name]=catalogue
/logos?filter[collection_name]=catalogue,ordered

Allowed values are:

collection name	description
catalogue	All logos which are created in the api or in your app administration.
custom	All logos which are designed by you but not ordered.
ordered	All ordered logos.

List logos for a given date, only resources created after the provided date will be returned

/logos?filter[created_at_min]=2017-09-27

List logos for a given date, only resources created before the provided date will be returned

/logos?filter[created_at_max]=2017-11-15

List logos for a given date, only resources updated after the provided date will be returned

/logos?filter[updated_at_min]=2017-09-27

List logos for a given date, only resources updated before the provided date will be returned

/logos?filter[updated_at_max]=2017-09-27

See: Pagination, Filtering

Expanding relationships

You can expand some resources to show more details.

See: Expanding Objects

Expand production method

You can show the content of the production method instead of the id.

/logos?expand=production_method

Example listing logos

Request

GET /logos HTTP/1.1

Response

{
    "data": [
        {
            "id": 3,
            "base_logo_id": null,
            "state": "completed",
            "collection_name": "catalogue",
            "name": "logo",
            "production_method": 1,
            "texts": [],
            "media": [
                {
                    "id": 1858,
                    "is_test": 0,
                    "collection_name": "original-data",
                    "file_name": "logo.png",
                    "size": 7502,
                    "mime_type": "image/png",
                    "download_url": "https://smake-public.s3.eu-west-1.amazonaws.com/files/0b9036ff186147b78ea663f903b08033/logo.png?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIATV6IRLEXI2SRHX47%2F20220322%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20220322T134627Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Signature=43f91f2a28a0da62071d0f07e3f7b65960323e54f2facb4a74029d633ec952eb",
                    "state": "completed",
                    "requested": null,
                    "failure_message": null,
                    "created_at": "2022-03-22T13:46:07+00:00",
                    "updated_at": "2022-03-22T13:46:07+00:00"
                },
                {
                    "id": 1859,
                    "is_test": 0,
                    "collection_name": "production-file",
                    "file_name": "logo.png",
                    "size": 7502,
                    "mime_type": "image/png",
                    "download_url": "https://smake-public.s3.eu-west-1.amazonaws.com/files/c3d8ccbecf284c5e80ce6cef1db48c13/logo.png?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIATV6IRLEXI2SRHX47%2F20220322%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20220322T134627Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Signature=ef72e25aec04e82988644ab8f8782713d793da4426e3322e382f8d9958575865",
                    "state": "pending",
                    "requested": null,
                    "failure_message": null,
                    "created_at": "2022-03-22T13:46:07+00:00",
                    "updated_at": "2022-03-22T13:46:07+00:00"
                },
                {
                    "id": 1860,
                    "is_test": 0,
                    "collection_name": "preview-file",
                    "file_name": "logo.png",
                    "size": 28950,
                    "mime_type": "image/png",
                    "download_url": "https://smake-public.s3.eu-west-1.amazonaws.com/files/dd881c1dc3274779810ab8ed9e2d9b47/logo.png?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIATV6IRLEXI2SRHX47%2F20220322%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20220322T134627Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Signature=3b8ccb6eecf4011f515bfad7e7b12df3e41e083ef54a8c6cc35aff1483608cde",
                    "state": "pending",
                    "requested": null,
                    "failure_message": null,
                    "created_at": "2022-03-22T13:46:08+00:00",
                    "updated_at": "2022-03-22T13:46:08+00:00"
                }
            ],
            "failure_message": null,
            "created_at": "2022-03-22T13:46:04+00:00",
            "updated_at": "2022-03-22T13:46:08+00:00"
        },
        {
            "id": 2,
            "base_logo_id": null,
            "requested": [
                {
                    "url": "https://smake-public.s3.eu-west-1.amazonaws.com/testfiles/logo.png",
                    "collection_name": "production-file"
                }
            ],
            "state": "completed",
            "collection_name": "catalogue",
            "name": "logo",
            "production_method": 4,
            "texts": [],
            "media": [
                {
                    "id": 1857,
                    "is_test": 0,
                    "collection_name": "production-file",
                    "file_name": "logo.png",
                    "size": 7502,
                    "mime_type": "image/png",
                    "download_url": "https://smake-public.s3.eu-west-1.amazonaws.com/files/3bfd223e0cb44b959796ad4158eb3169/logo.png?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIATV6IRLEXI2SRHX47%2F20220322%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20220322T134627Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Signature=b0ff5be6891d1c9c0516d9de20b5c9edaa3114fb45b5df076a41fe6d286696ea",
                    "state": "completed",
                    "requested": null,
                    "failure_message": null,
                    "created_at": "2022-03-22T13:46:03+00:00",
                    "updated_at": "2022-03-22T13:46:03+00:00"
                }
            ],
            "failure_message": null,
            "created_at": "2022-03-22T13:46:01+00:00",
            "updated_at": "2022-03-22T13:46:03+00:00"
        },
        {
            "id": 1,
            "base_logo_id": null,
            "requested": [
                {
                    "url": "https://smake-public.s3.eu-west-1.amazonaws.com/testfiles/logo.png",
                    "collection_name": "production-file"
                }
            ],
            "state": "completed",
            "collection_name": "catalogue",
            "name": "logo",
            "production_method": 1,
            "texts": [],
            "media": [
                {
                    "id": 1854,
                    "is_test": 0,
                    "collection_name": "original-data",
                    "file_name": "logo.png",
                    "size": 7502,
                    "mime_type": "image/png",
                    "download_url": "https://smake-public.s3.eu-west-1.amazonaws.com/files/40b1b50df1d0423f9cc11a37b62a6f8d/logo.png?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIATV6IRLEXI2SRHX47%2F20220322%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20220322T134627Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Signature=7fc3dd5bb7960ff60d39461b767ed1dcb04006d4bf121759ef499b092ddd4be1",
                    "state": "completed",
                    "requested": null,
                    "failure_message": null,
                    "created_at": "2022-03-22T13:45:58+00:00",
                    "updated_at": "2022-03-22T13:45:58+00:00"
                },
                {
                    "id": 1855,
                    "is_test": 0,
                    "collection_name": "production-file",
                    "file_name": "logo.png",
                    "size": 7502,
                    "mime_type": "image/png",
                    "download_url": "https://smake-public.s3.eu-west-1.amazonaws.com/files/333440cf2e1a43f0b4f79ce771223b5a/logo.png?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIATV6IRLEXI2SRHX47%2F20220322%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20220322T134627Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Signature=aac8a299bdc7859497e46d20cfdc793c3b6a1fe2b82bd4aa5f80ec2a9b8bb873",
                    "state": "pending",
                    "requested": null,
                    "failure_message": null,
                    "created_at": "2022-03-22T13:45:58+00:00",
                    "updated_at": "2022-03-22T13:45:58+00:00"
                },
                {
                    "id": 1856,
                    "is_test": 0,
                    "collection_name": "preview-file",
                    "file_name": "logo.png",
                    "size": 28950,
                    "mime_type": "image/png",
                    "download_url": "https://smake-public.s3.eu-west-1.amazonaws.com/files/b212cfc3505a42e5bc4d1fb53388824d/logo.png?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIATV6IRLEXI2SRHX47%2F20220322%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20220322T134627Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Signature=f55ec95dea06ea553956b484097ecbb2c2786874e0fae26c58a77809eefb567e",
                    "state": "pending",
                    "requested": null,
                    "failure_message": null,
                    "created_at": "2022-03-22T13:45:59+00:00",
                    "updated_at": "2022-03-22T13:45:59+00:00"
                }
            ],
            "failure_message": null,
            "created_at": "2022-03-22T13:45:56+00:00",
            "updated_at": "2022-03-22T13:46:00+00:00"
        }
    ],
    "links": {
        "first": "https://api.smake.io/v2/apps/1/logos?filter%5Bid%5D=1%2C2%2C3&page=1",
        "last": null,
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "path": "https://api.smake.io/v2/apps/1/logos",
        "per_page": 25,
        "to": 3
    }
}

Example expanding relationships

Request

GET /logos?expand=production_method HTTP/1.1

Response

{
    "data": [
        {
            "id": 1,
            "base_logo_id": null,
            "state": "completed",
            "collection_name": "catalogue",
            "name": "logo",
            "production_method": {
                "id": 1,
                "collection_name": "dtg",
                "handle": "dtg",
                "name": "Digital print",
                "description": "Digital print",
                "created_at": "2022-03-22T07:01:12+00:00",
                "updated_at": "2022-03-22T07:01:12+00:00"
            },
            "texts": [],
            "media": [
                {
                    "id": 1854,
                    "is_test": 0,
                    "collection_name": "original-data",
                    "file_name": "logo.png",
                    "size": 7502,
                    "mime_type": "image/png",
                    "download_url": "https://smake-public.s3.eu-west-1.amazonaws.com/files/40b1b50df1d0423f9cc11a37b62a6f8d/logo.png?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIATV6IRLEXI2SRHX47%2F20220322%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20220322T135027Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Signature=a6f559887086bfa0c8537814387304fdca4e73f11924a59841690788039d0bc6",
                    "state": "completed",
                    "requested": null,
                    "failure_message": null,
                    "created_at": "2022-03-22T13:45:58+00:00",
                    "updated_at": "2022-03-22T13:45:58+00:00"
                },
                {
                    "id": 1855,
                    "is_test": 0,
                    "collection_name": "production-file",
                    "file_name": "logo.png",
                    "size": 7502,
                    "mime_type": "image/png",
                    "download_url": "https://smake-public.s3.eu-west-1.amazonaws.com/files/333440cf2e1a43f0b4f79ce771223b5a/logo.png?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIATV6IRLEXI2SRHX47%2F20220322%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20220322T135027Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Signature=255aa9a3db6409315e69a15fd807b87182ce5329d7dba417b044c378b1ce9a5e",
                    "state": "pending",
                    "requested": null,
                    "failure_message": null,
                    "created_at": "2022-03-22T13:45:58+00:00",
                    "updated_at": "2022-03-22T13:45:58+00:00"
                },
                {
                    "id": 1856,
                    "is_test": 0,
                    "collection_name": "preview-file",
                    "file_name": "logo.png",
                    "size": 28950,
                    "mime_type": "image/png",
                    "download_url": "https://smake-public.s3.eu-west-1.amazonaws.com/files/b212cfc3505a42e5bc4d1fb53388824d/logo.png?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIATV6IRLEXI2SRHX47%2F20220322%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20220322T135027Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Signature=02a4d7fd30665255770754339ddcc33ed8b5460cc209911f4f21fdd285ed7018",
                    "state": "pending",
                    "requested": null,
                    "failure_message": null,
                    "created_at": "2022-03-22T13:45:59+00:00",
                    "updated_at": "2022-03-22T13:45:59+00:00"
                }
            ],
            "failure_message": null,
            "created_at": "2022-03-22T13:45:56+00:00",
            "updated_at": "2022-03-22T13:46:00+00:00"
        }
    ],
    "links": {
        "first": "https://api.smake.io/v2/apps/1/logos?expand=production_method&filter%5Bid%5D=1&page=1",
        "last": null,
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "path": "https://api.smake.io/v2/apps/1/logos",
        "per_page": 25,
        "to": 1
    }
}

GET

Returns the logo with the id = x.

Expanding relationships

You can expand some resources to show more details.

See: Expanding Objects

Expand production method

You can show the content of the production method instead of the id.

/logos/1?expand=production_method

Example get a logo

Request

GET /logos/1 HTTP/1.1

Response

{
    "id": 1,
    "base_logo_id": null,
    "requested": [
        {
            "url": "https://smake-public.s3.eu-west-1.amazonaws.com/testfiles/logo.png",
            "collection_name": "production-file"
        }
    ],
    "state": "completed",
    "collection_name": "catalogue",
    "name": "logo",
    "production_method": 1,
    "texts": [],
    "media": [
        {
            "id": 1854,
            "is_test": 0,
            "collection_name": "original-data",
            "file_name": "logo.png",
            "size": 7502,
            "mime_type": "image/png",
            "download_url": "https://smake-public.s3.eu-west-1.amazonaws.com/files/40b1b50df1d0423f9cc11a37b62a6f8d/logo.png?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIATV6IRLEXI2SRHX47%2F20220322%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20220322T135511Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Signature=a4ffe1e811255ab158d1ae984d2876d4f6a3f3e4986472632f66fb71381635a0",
            "state": "completed",
            "requested": null,
            "failure_message": null,
            "created_at": "2022-03-22T13:45:58+00:00",
            "updated_at": "2022-03-22T13:45:58+00:00"
        },
        {
            "id": 1855,
            "is_test": 0,
            "collection_name": "production-file",
            "file_name": "logo.png",
            "size": 7502,
            "mime_type": "image/png",
            "download_url": "https://smake-public.s3.eu-west-1.amazonaws.com/files/333440cf2e1a43f0b4f79ce771223b5a/logo.png?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIATV6IRLEXI2SRHX47%2F20220322%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20220322T135511Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Signature=4a829a8fb0a9d697fe20d25ea0dcded1aba16b084bd2793ce83c00aeed737975",
            "state": "pending",
            "requested": null,
            "failure_message": null,
            "created_at": "2022-03-22T13:45:58+00:00",
            "updated_at": "2022-03-22T13:45:58+00:00"
        },
        {
            "id": 1856,
            "is_test": 0,
            "collection_name": "preview-file",
            "file_name": "logo.png",
            "size": 28950,
            "mime_type": "image/png",
            "download_url": "https://smake-public.s3.eu-west-1.amazonaws.com/files/b212cfc3505a42e5bc4d1fb53388824d/logo.png?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIATV6IRLEXI2SRHX47%2F20220322%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20220322T135511Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Signature=3a9aee75d85cf41ea02277edf3768ee4196ea1855776bff4660f7deee78eb2be",
            "state": "pending",
            "requested": null,
            "failure_message": null,
            "created_at": "2022-03-22T13:45:59+00:00",
            "updated_at": "2022-03-22T13:45:59+00:00"
        }
    ],
    "failure_message": null,
    "created_at": "2022-03-22T13:45:56+00:00",
    "updated_at": "2022-03-22T13:46:00+00:00"
}

Example expanding relationships

Request

GET /logos/1?expand=production_method HTTP/1.1

Response

{
    "id": 1,
    "base_logo_id": null,
    "requested": [
        {
            "url": "https://smake-public.s3.eu-west-1.amazonaws.com/testfiles/logo.png",
            "collection_name": "production-file"
        }
    ],
    "state": "completed",
    "collection_name": "catalogue",
    "name": "logo",
    "production_method": {
        "id": 1,
        "collection_name": "dtg",
        "handle": "dtg",
        "name": "Digital-Direktdruck",
        "description": "Mit dem Digital-Direktdruck (DTG = Direct to Garment) aktivierst du ein modernes Verfahren in deiner Produktion, um Textilien in hoher Qualität nachhaltig zu bedrucken.",
        "created_at": "2022-03-22T07:01:12+00:00",
        "updated_at": "2022-03-22T07:01:12+00:00"
    },
    "texts": [],
    "media": [
        {
            "id": 1854,
            "is_test": 0,
            "collection_name": "original-data",
            "file_name": "logo.png",
            "size": 7502,
            "mime_type": "image/png",
            "download_url": "https://smake-public.s3.eu-west-1.amazonaws.com/files/40b1b50df1d0423f9cc11a37b62a6f8d/logo.png?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIATV6IRLEXI2SRHX47%2F20220322%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20220322T135713Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Signature=29764e1ec917410a0bc97de2a75c4119c587e5bd123b37945d25cf22775498d8",
            "state": "completed",
            "requested": null,
            "failure_message": null,
            "created_at": "2022-03-22T13:45:58+00:00",
            "updated_at": "2022-03-22T13:45:58+00:00"
        },
        {
            "id": 1855,
            "is_test": 0,
            "collection_name": "production-file",
            "file_name": "logo.png",
            "size": 7502,
            "mime_type": "image/png",
            "download_url": "https://smake-public.s3.eu-west-1.amazonaws.com/files/333440cf2e1a43f0b4f79ce771223b5a/logo.png?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIATV6IRLEXI2SRHX47%2F20220322%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20220322T135713Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Signature=b4cd89294951a1c66df70fe560e104ce50c071bafe367c6833e5bbd72b9c8b4c",
            "state": "pending",
            "requested": null,
            "failure_message": null,
            "created_at": "2022-03-22T13:45:58+00:00",
            "updated_at": "2022-03-22T13:45:58+00:00"
        },
        {
            "id": 1856,
            "is_test": 0,
            "collection_name": "preview-file",
            "file_name": "logo.png",
            "size": 28950,
            "mime_type": "image/png",
            "download_url": "https://smake-public.s3.eu-west-1.amazonaws.com/files/b212cfc3505a42e5bc4d1fb53388824d/logo.png?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIATV6IRLEXI2SRHX47%2F20220322%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20220322T135713Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Signature=4404e1bf1bb39bae88640b0b45411da151a9ab26cb3160fa41a11be4a2f33141",
            "state": "pending",
            "requested": null,
            "failure_message": null,
            "created_at": "2022-03-22T13:45:59+00:00",
            "updated_at": "2022-03-22T13:45:59+00:00"
        }
    ],
    "failure_message": null,
    "created_at": "2022-03-22T13:45:56+00:00",
    "updated_at": "2022-03-22T13:46:00+00:00"
}

Create

You can create an logo here with a url or a uploaded media id. See Upload Media. Allowed production methods are for DTG and Manual processing.

Background processing

When you create a logo, this happens asynchronously, and you have to use Polling or Webhooks. You will receive the new logo id in the header for later reference.

The current state of the asynchronous process is represented due following states:

State	Meaning
`draft`	The initial state of a new logo.
`checking`	Logo is processed automatically in background. For example images will be generated or downloaded.
`failed`	Something went wrong during the checking process. The reason can be found in the `failure_message` attribute. For example an image could not be downloaded.
`completed`	All automatic processes were successful. The logo is ready to use.

It is not possible to use this logo before state completed.

Media Array / Media Object

The request field media is always an array of media objects

Field	Type	Description	Required
collection_name	string	Unique identifier for the intended use. Allowed name is `production-file`.	yes
id	int	Use this `id` if you want to use an existing Media from your uploads. See Media.	yes*
url	string	Url which references a file. This file will be downloaded and attached to the resource.	yes*

* You have to choose exactly one of id or url.

Production Method Object

For a list of available production methods see Production Methods.

Field	Type	Description	Required
id	int	The production methods id.	yes*
handle	string	The production method handle which is defined by the producer.	yes*

* You have to choose exactly one of id or handle.

Example

Request

POST logos HTTP/1.1

{
    "production_method": {
        "handle": "dtg"
    },
    "media": [
        {
            "url": "https://smake-public.s3.eu-west-1.amazonaws.com/testfiles/logo.png",
            "collection_name": "production-file"
        }
    ]
}

Response

HTTP/1.1 202 Accepted
Location https://api.smake.io/jobs/1
X-Identifier: 2

Further create examples

Create with media id

Request

POST logos HTTP/1.1

{
    "production_method": {
        "handle": "dtg"
    },
    "media": [
        {
            "id": 1865,
            "collection_name": "production-file"
        }
    ]
}

Create with media id and production method id

Request

POST logos HTTP/1.1

{
    "production_method": {
        "id": 1
    },
    "media": [
        {
            "id": 1865,
            "collection_name": "production-file"
        }
    ]
}

Design Logo

You can create a new designed logo here. The logo you use for designing must contain at least one text element.

Background processing

When you design a logo, this happens asynchronously and you have to use Polling or Webhooks. You will receive the new logo idin the header for later reference.

The current state of the asynchronous process is represented due following states:

State	Meaning
`draft`	The initial state of a new logo
`checking`	Logo is processed automatically in background. For example images will be generated or downloaded.
`failed`	Something went wrong during the checking process. The reason can be found in the `failure_message` attribute. For example an image could not be downloaded.
`completed`	All automatic processes were successful. The logo is ready to use.

It is not possible to use this logo before state completed.

How to Design

You can change the the texts of the logo here

Field	Type	Description	Required
texts	array	Contains the texts which are included in the logo. See Text Object	yes

Text Object

Field	Type	Description	Required
name	string	Contains the texts name. It is used to address the text.	yes
lines	array	Contains lines as string.	yes

Example

Request

POST logos/1/design

{
    "texts": [
        {
            "name": "Text_1",
            "lines": [
                "kurzer Text1"
            ]
        }
    ]
}

Response

HTTP/1.1 202 Accepted
Location https://api.smake.io/jobs/1
X-Identifier: 2

Logos

#List

#Filtering

#List logos for specified id(s)

#List logos for specified production method handle(s)

#List logos for specified production method id(s)

#List logos for specified production collection names(s)

#List logos for a given date, only resources created after the provided date will be returned

#List logos for a given date, only resources created before the provided date will be returned

#List logos for a given date, only resources updated after the provided date will be returned

#List logos for a given date, only resources updated before the provided date will be returned

#Expanding relationships

#Expand production method

#Example listing logos

#Example expanding relationships

#GET

#Expanding relationships

#Expand production method

#Example get a logo

#Example expanding relationships

#Create

#Background processing

#Media Array / Media Object

#Production Method Object

#Example

#Further create examples

#Create with media id

#Create with media id and production method id

#Design Logo

#Background processing

#How to Design

#Text Object

#Example

List

Filtering

List logos for specified id(s)

List logos for specified production method handle(s)

List logos for specified production method id(s)

List logos for specified production collection names(s)

List logos for a given date, only resources created after the provided date will be returned

List logos for a given date, only resources created before the provided date will be returned

List logos for a given date, only resources updated after the provided date will be returned

List logos for a given date, only resources updated before the provided date will be returned

Expanding relationships

Expand production method

Example listing logos

Example expanding relationships

GET

Expanding relationships

Expand production method

Example get a logo

Example expanding relationships

Create

Background processing

Media Array / Media Object

Production Method Object

Example

Further create examples

Create with media id

Create with media id and production method id

Design Logo

Background processing

How to Design

Text Object

Example