The different segments for the entry-point url can be separated as:
https:// domain / APIv / token / alias / path-img ? xfs
| above | Segment | Description | Value |
|---|---|---|---|
| https:// | Protocol | The HTTP protocol | https:// |
| domain | Service domain | The domain used to hit the service | cdn.ixmage.com |
| APIv | API Version | In case of a new feature that may introduce breaking changes in how the entry-point url is used | v2 |
| token | Account Token | This segment will identify your account | |
| Your account token is case-sensitive | |||
| alias | Alias | An alias in your account to find the requested image | |
| path-img | Image | The path to the image within your alias | |
| The path and image name may or may no be case-sensitive depending on where your alias is pointing to. An AWS S3 bucket will expect case-sensitivity, where typically an IIS source will not. | |||
| xfs | Transformations | The instructions on how to transform the image |
Once you register an account by identifying yourself with one of the Auth0 available providers (facebook | google | twitter) you will be assigned a token like TQKkCpGYGK which you can then use in the entry-point url.
Another segment you will need to set up is an alias. With the alias done, you can start requesting images using the service.
https:// cdn.ixmage.com / v2 / MyToKeN / my-alias / my-image
Let’s assume we have a web-server online, and it resolves to https://my-server.com
And then in that server we have some public and available images in a folder images; and one of the images is called my-image.png.
So if we go to url https://my-server.com/images/my-image.png we will see the image.
In our control panel, we will set up an alias that points to https://my-server.com/images
| Property | Value | Explanation |
|---|---|---|
| Name | my-alias | We give our alias a name |
| Type | fetch | This is the default and most common type |
| url | https://my-server.com/images | We tell the alias where it can go find our images |
These 3 properties are enough for our test.
The alias can point to any number of nested folders like https://my-server/folderA/folderB/folderC and you would complete the path in the path-img portion.
No let’s tell our browser to go to:
https://cdn.ixmage.com/v2/MyToKeN/my-alias/my-image.png
We will see our image, most likely a tiny version of it, because we have not specified any dimensions, the service will serve a small variant.
The service will detect my-alias and go grab the original image from my-server.com/images /my-image.png
To extend on the alias and path-img segments…
Imagine there is an image in your server at /images/folder/subfolder/another-image.png
The url to it would be https://cdn.ixmage.com/v2/MyToKeN/my-alias/folder/subfolder/another-image.png
