Welcome to Micro Tiling’s documentation!¶
REST API Usage¶
A running API is hosted at https://micro-tiling.tk
¶
POST /
Creates a new job
- Description:
- Produces: [‘application/json’]
Responses
200 - Succesfuly created job
Name | Description | Type |
---|---|---|
id | string |
405 - Invalid input
GET /{jobId}/state
Gets the state of a job
- Description:
- Produces: [‘application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
jobId | path | The ID of the requested job | string |
Responses
200 - State of the job
Name | Description | Type |
---|---|---|
completion | integer | |
state | string |
400 - Invalid ID supplied
404 - Unknown Job
405 - Invalid Method
GET /{jobId}/address
Gets the address needing ensicoins for a job
- Description:
- Produces: [‘application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
jobId | path | The ID of the requested job | string |
Responses
200 - Ensicoin address
Name | Description | Type |
---|---|---|
address | string |
400 - Invalid ID supplied
404 - Unknown Job or No Address needed
405 - Invalid Method
GET /{jobId}/result
Get the final mosaic in a job
- Description:
- Produces: [‘application/json’]
Parameters
Name | Position | Description | Type |
---|---|---|---|
jobId | path | The ID of the requested job | string |
Responses
200 - SVG file
Name | Description | Type |
---|---|---|
result | string |
400 - Invalid ID supplied
404 - Unknown Job or Job not done
405 - Invalid Method