HTTPS GET [web_admin_domain]/oauth/authorize
DESCRIPTION
This starts the OAuth 2.0 authorization flow
PARAMETERS
response_type required. The grant type requested, either token or code.
client_id required. The app's key, found in the administration panel
redirect_uri required. Where to redirect the user after authorization has completed. This must be the exact URI registered in the administration panel
scope Possible values are 'read' or 'write'. The default value is 'read'
state Bytes of arbitrary data that will be passed back to your redirect URI. This parameter should be used to protect against cross-site request forgery (CSRF).
client_id required. The app's key, found in the administration panel
redirect_uri required. Where to redirect the user after authorization has completed. This must be the exact URI registered in the administration panel
scope Possible values are 'read' or 'write'. The default value is 'read'
state Bytes of arbitrary data that will be passed back to your redirect URI. This parameter should be used to protect against cross-site request forgery (CSRF).
RETURNS
Because [web_admin_domain]/oauth/authorize is a website, there is no direct return value. However, after the user authorizes your app, they will be sent to your redirect URI.
The type of response varies based on the response_type.
HTTPS GET [web_admin_domain]/oauth/authorizewithaccesskey?accesskey=[accesskey]
DESCRIPTION
This starts the OAuth 2.0 authorization flow using an access key.
PARAMETERS
accesskey required. An access key. This key can be obtained by log in to user panel and navigate to access keys section
If the connection is not secure the access key must be encrypted using a key and an algorithm which they can be obtained by calling [web_admin_domain]/oauth/getpublickey
RETURNS
A JSON-encoded result including an access token and expires_in property in seconds
{
success = true,
data = [ the accessToken ],
expires_in: "7200"
}
success = true,
data = [ the accessToken ],
expires_in: "7200"
}
HTTPS GET [web_admin_domain]/oauth/getPublickey
DESCRIPTION
Get a public key and the name of the algorithm in order to decrypt the access key. The name of the algorith will always be "rsa"
Please follow the following links to learn about Rsa Rsa Wiki | Rsa OpenSSL
* Openssl Command Line Example for encryption: $ openssl rsautl -encrypt -inkey public.pem -pubin -in file.txt -out file.ssl
PARAMETERS
No parameters
RETURNS
A JSON-encoded result including a public key in PEM format and algorithm name
{
success = true,
key = 'the key in PEM format' ],
algorithm = 'rsa'.
}
success = true,
key = 'the key in PEM format' ],
algorithm = 'rsa'.
}
HTTPS POST [web_admin_domain]/oauth/token
DESCRIPTION
This endpoint only applies to apps using the authorization code flow. An app calls this endpoint to acquire a bearer token once the user has authorized the app.
PARAMETERS
code required. The code acquired by directing users to authorize?response_type=code.
grant_type required. The grant type, which must be authorization_code.
client_id required. The app's key
client_secret required. The app's secret.
redirect_uri Only used to validate that it matches the original /oauth/authorize, not used to redirect again.
grant_type required. The grant type, which must be authorization_code.
client_id required. The app's key
client_secret required. The app's secret.
redirect_uri Only used to validate that it matches the original /oauth/authorize, not used to redirect again.
RETURNS
A JSON-encoded result including an access token (access_token), token type (token_type) and expires date. The token type will always be "bearer".
{
access_token: "gAAAAHI9GG07oCsv1aC-4_GBPQVPxdb85rtGZlrvVOSA......,
expires_in: "7200",
token_type: "bearer" }
access_token: "gAAAAHI9GG07oCsv1aC-4_GBPQVPxdb85rtGZlrvVOSA......,
expires_in: "7200",
token_type: "bearer" }
HTTPS POST [web_admin_domain]/oauth/refreshToken
DESCRIPTION
Get a new access token by providing the refresh token, client id and client secret
PARAMETERS
refreshToken required. The refresh code
client_id required. The client identifier
client_secret required. The clients secret
client_id required. The client identifier
client_secret required. The clients secret
* Add the following header to your request. Content-Type: application/x-www-form-urlencoded
* Body Example: refreshToken=someToken&client_id=clID&client_secret=clSecret
RETURNS
A JSON-encoded result including an access token (access_token) and expires_in property in seconds.
{
access_token: "gAAAAHI9GG07oCsv1aC-4_GBPQVPxdb85rtGZlrvVOSA......,
expires_in: "7200",
}
access_token: "gAAAAHI9GG07oCsv1aC-4_GBPQVPxdb85rtGZlrvVOSA......,
expires_in: "7200",
}
HTTPS GET [api_admin_domain]/api/tags/listtags
DESCRIPTION
Get a list of all user's tags
PARAMETERS
No parameters
RETURNS
A JSON-encoded result including an array of tags. See below
{
success = true,
data = [ {TagID: 1, TagName: images}, {TagID: 12, TagName: embroidery} ]
}
success = true,
data = [ {TagID: 1, TagName: images}, {TagID: 12, TagName: embroidery} ]
}
HTTPS POST [api_admin_domain]/api/tags/postTag/{tagName}
DESCRIPTION
Create a new tag with name {tagName}
PARAMETERS
tagName required. The tag name of the new tag
RETURNS
A JSON-encoded result including the new tag
{
success = true,
data = {TagID: 15, TagName: theNewTagName}
}
success = true,
data = {TagID: 15, TagName: theNewTagName}
}
HTTPS PUT [api_admin_domain]/api/tags/RenameTag/{tagName}?newTagName={theNewNameOfTheTag}
DESCRIPTION
Rename an existing tag with name {tagName} to {theNewNameOfTheTag}
PARAMETERS
tagName required. The tag name of the existing tag
theNewNameOfTheTag required. The new name of the tag
RETURNS
A JSON-encoded result including the new tag
{
success = true,
data = {TagID: 15, TagName: theNewNameOfTheTag}
}
success = true,
data = {TagID: 15, TagName: theNewNameOfTheTag}
}
HTTPS DELETE [api_admin_domain]/api/tags/DeleteTag/{tagName}
DESCRIPTION
Delete an existing tag with name {tagName}
PARAMETERS
tagName required. The tag name of the existing tag
RETURNS
A JSON-encoded result. See below
{
success = true,
data = ""
}
success = true,
data = ""
}
HTTPS GET [api_admin_domain]/api/tags/GetTagsInFiles/{fileId}
DESCRIPTION
Get the Tags which are related to a file with file ID={fileID}
PARAMETERS
fileId required. The id of the file.
RETURNS
A JSON-encoded result including an array of Tags.
{
success = true,
data = [ {TagID: 1, TagName: images}, {TagID: 12, TagName: embroidery} ]
}
success = true,
data = [ {TagID: 1, TagName: images}, {TagID: 12, TagName: embroidery} ]
}
HTTPS GET [api_admin_domain]/api/files/GetFile/{fileName}
DESCRIPTION
Download a file with name={filename}
PARAMETERS
fileName required. The name of the file.
RETURNS
HTTPS POST [api_admin_domain]/api/files/postFile
DESCRIPTION
Upload a file.
PARAMETERS
Add to the body of the post request the file with field-name='file'.
RETURNS
A JSON-encoded result.
{
success = true,
data = "Your file with name {the file name} has been successfully uploaded
}
success = true,
data = "Your file with name {the file name} has been successfully uploaded
}
HTTPS GET [api_admin_domain]/api/files/ListFiles/{TagID}?partName={partOfTheFileName}
DESCRIPTION
Get an array of files that are associate with a tag {TagID} and the name contains the {partOfTheFileName}. If TagID and partName are not specified the method will return all the files
PARAMETERS
TagID not required. The tagID of the Tag which is associate with the files
partOfTheFileName not required. Part of the file name.
partOfTheFileName not required. Part of the file name.
RETURNS
A JSON-encoded result including an array of files with some file info for each file. See below
{
success = true,
data = [ {Name: A1.jpg, NumBytes: 102911, NumStitches: null, FileType: Generic}, {Name: B1.PXF, NumBytes: 64999, NumStitches: 454585, FileType: Embroidery} ]
}
success = true,
data = [ {Name: A1.jpg, NumBytes: 102911, NumStitches: null, FileType: Generic}, {Name: B1.PXF, NumBytes: 64999, NumStitches: 454585, FileType: Embroidery} ]
}
HTTPS GET [api_admin_domain]/api/files/getMetadata/{fileName}
DESCRIPTION
Get metadata of a file with name={fileName}
PARAMETERS
fileName required. The file name of the file need to get the metadata
RETURNS
A JSON-encoded result including file metadata information. See below
{
success = true,
data = {Name: B1.PXF, NumBytes: 64999, NumStitches: 454585, FileType: Embroidery}
}
success = true,
data = {Name: B1.PXF, NumBytes: 64999, NumStitches: 454585, FileType: Embroidery}
}
HTTPS GET [api_admin_domain]/api/files/getThumbnail/{fileName}
DESCRIPTION
Get the thumbnail(100x100) of a file with name={fileName}
PARAMETERS
fileName required. The file name of the file need to get the thumbnail
RETURNS
An image result ("image/png" media type)
HTTPS PUT [api_admin_domain]/api/files/RenameFile/{fileName}?newName={theNewFileName}
DESCRIPTION
Rename an existing file
PARAMETERS
fileName required. The file name of the file need to be renamed
theNewFileName required. The new file name
theNewFileName required. The new file name
RETURNS
A JSON-encoded result including the renamed file metadata. See below
{
success = true,
data = {Name: NewName.PXF, NumBytes: 64999, NumStitches: 454585, FileType: Embroidery}
}
success = true,
data = {Name: NewName.PXF, NumBytes: 64999, NumStitches: 454585, FileType: Embroidery}
}
HTTPS DELETE [api_admin_domain]/api/files/DeleteFile/{fileName}
DESCRIPTION
Delete an existing file
PARAMETERS
fileName required. The file name of the file need to be deleted
RETURNS
A JSON-encoded result. See below
{
success = true,
data = ""
}
success = true,
data = ""
}
HTTPS POST [api_admin_domain]/api/files/SetFileInTag/{fileName}?TagID={tagID}
DESCRIPTION
Associate a file with a tag
PARAMETERS
fileName required. The file name of the file need to be associated with a tag
tagID required. The tag id of the Tag need to be associated with the file
tagID required. The tag id of the Tag need to be associated with the file
RETURNS
A JSON-encoded result including file metadata. See below
{
success = true,
data = {Name: MyDesign.PXF, NumBytes: 18984, NumStitches: 54545, FileType: Embroidery}
}
success = true,
data = {Name: MyDesign.PXF, NumBytes: 18984, NumStitches: 54545, FileType: Embroidery}
}
HTTPS GET [api_admin_domain]/api/machines/GetMachinesList/
DESCRIPTION
Get a list with all machines belongs to an organization
PARAMETERS
No parameters
RETURNS
A JSON-encoded result including an array of machines. See below
{
success = true,
data = [ {MachineName: MAC-02345, SpoolerName:Spooler-Name1 , DesignSpoolerId: 1eee11132-e4b9-4216-9ae4-2c5b4af2fa8e}, {MachineName: MAC-02345-2, SpoolerName:Spooler-Name2 , DesignSpoolerId: 1fff11132-e4b9-4216-901e4-2c5b4af2fa8e} ]
}
success = true,
data = [ {MachineName: MAC-02345, SpoolerName:Spooler-Name1 , DesignSpoolerId: 1eee11132-e4b9-4216-9ae4-2c5b4af2fa8e}, {MachineName: MAC-02345-2, SpoolerName:Spooler-Name2 , DesignSpoolerId: 1fff11132-e4b9-4216-901e4-2c5b4af2fa8e} ]
}
HTTPS POST [api_admin_domain]/api/machines/AddMachineEvent/
DESCRIPTION
Add a machine event
PARAMETERS
EventType. The type of the event occured
MachineName required. The name of the machine
DesignSpoolerName required. The name of the spooler
DesignSpoolerId required. The id of the spooler
TimeStamp. The timestamp of the event. Example: 2014-06-12 12:00
Reason. The reason of the event.
DesingName. THe design name associated with the event
MachineName required. The name of the machine
DesignSpoolerName required. The name of the spooler
DesignSpoolerId required. The id of the spooler
TimeStamp. The timestamp of the event. Example: 2014-06-12 12:00
Reason. The reason of the event.
DesingName. THe design name associated with the event
* Add the following header to your request. Content-Type: application/x-www-form-urlencoded
* Body Example: EventType=MachineStopped&MachineName=Machine1&DesignSpoolerName=SpoolerName1&DesignSpoolerId=Sppoler_12&TimeStamp=2014-06-12 12:00&Reason=SomeReason&DesingName=sample.pxf
RETURNS
A JSON-encoded result including the id of the new machine event. See below
{
success = true,
data = 7
}
success = true,
data = 7
}
HTTPS POST [api_admin_domain]/api/machines/AddMachine/
DESCRIPTION
Add a machine
PARAMETERS
MachineName required. The name of the machine
DesignSpoolerName required. The name of the spooler
DesignSpoolerId required. The id of the spooler
DesignSpoolerName required. The name of the spooler
DesignSpoolerId required. The id of the spooler
* Add the following header to your request. Content-Type: application/x-www-form-urlencoded
* Body Example: MachineName=Machine1&DesignSpoolerName=SpoolerName&DesignSpoolerId=SpoolerID_345
RETURNS
A JSON-encoded result including the id of the new machine. See below
{
success = true,
data = 134
}
success = true,
data = 134
}
HTTPS POST [api_admin_domain]/api/synchronization/StartSynchingQueue
DESCRIPTION
Starts the synchronization proccess. This method will respond with 3 lists. PostToCloud list (designs that the cloud queue needs),
GetFromCloud list (designs that spooler needs to get from cloud), RemoveFromSpooler (designs that the spooler needs to remove)
PARAMETERS
spoolerID required. The spooler ID
spoolerDesigns required. List of spoolerInfo object. A spoolerInfo object is an object with 2 properties.
ID: of the design (has to be a unique id foreach design spooler's or clouds...perhaps a GUID. This id will be used to synch the queues)
IsSpoolersDesign: A boolean property to determine if a design is added through cloud or through other clients. false->cloud, true->other clients
spoolerDesigns required. List of spoolerInfo object. A spoolerInfo object is an object with 2 properties.
ID: of the design (has to be a unique id foreach design spooler's or clouds...perhaps a GUID. This id will be used to synch the queues)
IsSpoolersDesign: A boolean property to determine if a design is added through cloud or through other clients. false->cloud, true->other clients
* Add the following header to your request. Content-Type: application/x-www-form-urlencoded
*Body Example:
spoolerID=Spooler_12&SpoolerDesigns[0].ID=abc1234&SpoolerDesigns[0].IsSpoolersDesign=true&SpoolerDesigns[1].ID=efg567SpoolerDesigns[1].IsSpoolersDesign=false
RETURNS
A JSON-encoded result including the 3 lists mentioned above
{
success: true,
postToCloud:[{ID:some id, IsSpoolersDesign=true}, {...}],
getFromCloud: [{ID:... ,IsSpoolersDesign=false},{....}],
removeFromSpooler: [{ID:... ,IsSpoolersDesign=false},{....}]
}
success: true,
postToCloud:[{ID:some id, IsSpoolersDesign=true}, {...}],
getFromCloud: [{ID:... ,IsSpoolersDesign=false},{....}],
removeFromSpooler: [{ID:... ,IsSpoolersDesign=false},{....}]
}
HTTPS GET [api_admin_domain]/api/synchronization/getDesign?id=[designID]&spoolerID=[spoolerID]
DESCRIPTION
Get design metadata
PARAMETERS
id required. The design id
spoolerID required. The spooler id which design belongs to
spoolerID required. The spooler id which design belongs to
RETURNS
A JSON-encoded result including design info. See the example below
{
success: true,
name:"sample.pxf",
MachineName: "Machine1",
ID: "designID",
TimeStamp: "2014-06-12 12:50" **this is the datetime that the user requested to send it to a machine,
ListComments:[
{ Comment : "The comment's text 1", ShowBeforeSewing : false, ShowAfterSewing : true },
{ Comment : "The comment's text 2", ShowBeforeSewing : true, ShowAfterSewing : false }
]
}
success: true,
name:"sample.pxf",
MachineName: "Machine1",
ID: "designID",
TimeStamp: "2014-06-12 12:50" **this is the datetime that the user requested to send it to a machine,
ListComments:[
{ Comment : "The comment's text 1", ShowBeforeSewing : false, ShowAfterSewing : true },
{ Comment : "The comment's text 2", ShowBeforeSewing : true, ShowAfterSewing : false }
]
}
HTTPS POST [api_admin_domain]/api/synchronization/PostDesign
DESCRIPTION
Post design info to cloud's spooler
PARAMETERS
designInfo required. The design information cloud's spooler needs in order to add the design to it's queue
This information consists of the following properties: Name (the design name), MachineName (the machine name), ID (the design id),
IsSpoolersDesign (boolean if it's spooler's design or not), TimeStamp (the datetime added to the machine.)
spoolerID required. The spooler id
This information consists of the following properties: Name (the design name), MachineName (the machine name), ID (the design id),
IsSpoolersDesign (boolean if it's spooler's design or not), TimeStamp (the datetime added to the machine.)
spoolerID required. The spooler id
* Add the following header to your request. Content-Type: application/x-www-form-urlencoded
* Body Example: spoolerID=Spooler_12&ID=designID&IsSpoolersDesign=true&Name=designName&MachineName=machineName&TimeStamp=2014-06-25 12:50
RETURNS
A JSON-encoded result with success property set to true if the design successfully posted
{
success: true,
}
success: true,
}
HTTPS POST [api_admin_domain]/api/synchronization/FinishSynchingQueue
DESCRIPTION
When the sync queue process is ready to terminate (meaning that all getDesign and postDesign calls was sucessfully finished)
make a post call to FinishSynchingQueue. **keep in mind that you have to sort the spoolers queue after this call (based on designs timestamp)
PARAMETERS
spoolerID required. The spooler id
* Add the following header to your request. Content-Type: application/x-www-form-urlencoded
* Body Example: spoolerID=Spooler_12
RETURNS
A JSON-encoded result with success property set to true if the sync queue process was successfully terminated
{
success: true,
}
success: true,
}
Each time an error occured the success property of the json-encoded returned message will be false
In addition to, there will be another property "ErrorMessage" that will contain a message which will describe the error. See below an example
{
success = false,
ErrorMessage="Invalid access token"
}
success = false,
ErrorMessage="Invalid access token"
}
Finally, these error results will be accompanied with some status codes.
404: The resource that you are looking for is not found
403: The acces token used for the request in not valid
401: The acces token used for the request is not valid because the user that owns the resource have disable the access permission
400: In general bad request. Make sure you have used the right method for the request (get, post, put, or delete)
500: Internal Server Error. Smothing bad happened in the server
403: The acces token used for the request in not valid
401: The acces token used for the request is not valid because the user that owns the resource have disable the access permission
400: In general bad request. Make sure you have used the right method for the request (get, post, put, or delete)
500: Internal Server Error. Smothing bad happened in the server