Français | English

Onprint API Documentation

Getting started

Authentication

Onprint uses OAuth2 as authentication standard. First, a token must be retrieved from a token endpoint, and then any call to the API, except the EnrichedImage and Click endpoints, must specify OAuth2 authentication type and token in the header. We will explain it more in detail below.

Token

POST /token

The first step at login is to get a token using the standard OAuth2 request, also with a header containing the ApiKey. Username and password must be provided as a formData content. Example of form-data:

grant_type=password&username=toto@onprint.com&password=test

The content-type of the POST request must be application/x-www-form-urlencoded

The ApiKey Header must be provided as follows. It will return a Json containing user information and the token : ApiKey:xxx

The token is in the field: access_token

The token has an expiration date, also available in the response.

Header for API calls

Once we have the token to connect, we will use OAuth authentication for every API call, except the ones described below. The header must be built as follows:

Key: Authorization
Value: bearer token value

Example: Authorization: Bearer AQAAANCMnd8BFdERjHoAwE_Cl-sBAAAAHufd(…)

Endpoints that do not require authentication

These endpoints are for image search or user creation / password recovery. As they do not require authentication, the ApiKey header (as well as others, see details in each endpoint part) will have to be set.

GET and POST /api/EnrichedImages
PUT /api/Clicks
POST /api/Pictures/Search

User rights and roles, node hierarchy

Node hierarchy

Objects in the platform are organized in nodes. Here are the main rules:

Nodes can be organizations, folders, documents, images or zones.
An organization can contain child organizations, folders or documents.
A folder can only contain documents.
A document can only contain images and images can only be contained in a document.
An image can contain zones and zones can only be contained in an image.
A user is attached to an organization, and his/her right levels will depend on the node level.

User roles

3 roles can be used in the Onprint API. A user can have one or more roles.

Administrator: Can see, edit, add, delete users in his/her own organization (peers).
CustomerAccountManager: Can see, edit, add, delete users who belong to children organizations (customers). Can see, edit, add, delete documents, folders, organizations under the customer organization.
Designer: Can see, edit, add, delete documents, folders, organizations in its own organization.

Return codes

Here is a list of the main Return Codes in use in the application.

Success

200 OK

Standard response for successful HTTP requests. The actual response will depend on the request method used. In a GET request, the response will contain an entity corresponding to the requested resource.
Example of use: in resource Folder, in GET /api/Folders/{id}, if the folder is found it is returned in the response body with return code 200.

201 Created

The request has been fulfilled, resulting in the creation of a new resource.
Example of use: in resource Document, in POST /api/Documents, if the document could be created with no errors, return code is 201. The new document is returned in the response body.

204 No Content

The server successfully processed the request and is not returning any content.
Example of use: in resource EnrichedImage, in POST /api/EnrichedImages, if the request was successful but no corresponding image was recognized, or did not contain any action, the return code is 204.
Another example: in resource DocumentLanguage, in PUT /api/DocumentLanguages, if the language was correctly added to the document, the return code is 204.

Client Error

400 Bad Request

The server cannot or will not process the request due to an apparent client error. Example of use: in resource Icon, in PUT /api/Icons/{id}, if the image that is sent in the request is too large, the server will not be able to process the request and will respond 400.

401 Unauthorized

When authentication is required and has failed or has not yet been provided.
Example of use: in any resource that needs authentication, if the Authorization header is not set, the server will respond 401.

403 Forbidden

The request was a valid request, but the server is refusing to respond to it.
Example of use: in resource Account, in GET /api/accounts?organizationId={id}, if the user role does not allow him/her to see the organization, the response will be 403.

404 Not Found

The requested resource could not be found but may be available in the future. Example of use: in resource Action, in POST /api/Actions, If the given parent DocumentId does not lead to an existing document, the server will say that the resource cannot be found and return 404.

Server Error

500 Internal Server Error

This error should not happen, but can be raised when we did not handle properly something on the server side. Sometimes because of a bad request, or a bug. If you encounter this, please contact Onprint.

Image Enrichment

Documents

Document management.

Property	Type	Description	Comment
Id	Guid		Read-Only, generated
ParentId	Guid
DefaultLanguage	String	Default language used for scan
Name	String
ContentType	String	MIME ContentType	Read-Only
Pages	Int	Pages count	Read-Only
ActionCount	Int	Action Count	Read-Only
Status	String		(see below) Can only be from active to inactive and back
Cover	String	Document Cover thumbnail URL	Read-Only
DateCreated	DateTime		Read-Only
DateModified	DateTime		Read-Only

Document Status enumeration

Error: there was an error on the document.
Active: the document is uploaded and active, ready for recognition.
Inactive: the document is correctly uploaded but not activated on the server.
Preparation: the document is just created, images are being built and resized on the server.

GET description

/api/Nodes/{nodeId}/Documents

Parameter: NodeId (in path): node identifier (Node)
Returns: List of documents that are children of the node

/api/Documents/{id}

Parameter: DocumentId (in path): document identifier (Document)
Returns: Single document

POST rules

The POST method is used to create a document by sending the document file and its properties.
The request body content type must be Multipart (multipart/form-data). The content is made of a File data (file) and a Form data (document).

Async parameter

In the URL, a parameter named async can be set like this: POST /api/Documents?async=false. Defaults to true if not set. When this parameter is true, the image creation is made asynchronously and the method returns directly. When it is false, the method waits for the image creation before returning. The difference between both methods is important in the case of a PDF file.

FileData (file)

The document itself. It can be a JPEG, PNG, GIF image, or a PDF document. The MIME type has to be given in the file content type.

FormData (document)

Contains a Document object. The form data name is document. DefaultLanguage, Name and ParentId are mandatory.

PUT method

PUT is a multipart method where only the attached file will be read, to replace the image. To modify document properties, a PATCH will have to be done.

FileData (file)

The document replacement itself. It can be a JPEG, PNG, GIF image, or a PDF document. The MIME type has to be given in the file content type.

PATCH fields

Can be sent independently: DefaultLanguage, Name, ParentId, Status.

DELETE description

/api/Documents/{id}

Parameter: DocumentId (in path): document identifier (Document)

Images

Images are contained into a document. They are created when creating the document; it is not possible to create an image outside a document.

Property	Type	Description	Comment
Id	Guid		Read-Only, generated
DocumentId	Guid
Status	String	(see below)	Read-Only
Name	String
ActionCount	Int		Read-Only
ZoneCount	Int		Read-Only
Order	Int	Order in document
AutoTrigger	Bool?	Auto trigger of the action. Only if 1 action
SmallThumbnail	String	100px thumbnail	Read-Only
BigThumbnail	String	700px thumbnail	Read-Only
DateCreated	DateTime		Read-Only
DateModified	DateTime		Read-Only

Image status enumeration

Active: the parent document is active
Inactive: the parent document is inactive
GET description

/api/Documents/{documentId}/Images
Parameter: documentId (in path): document identifier (Document)
Returns: List of images that are children of the document
/api/Images/{id}
Parameter: Id (in path): image identifier (Image)
Returns: Single image

PUT rules

Name, Order, Status are mandatory.

PATCH fields

Can be sent independently: AutoTrigger, Name, Order, Status.

DELETE description

/api/Images/{id}

Parameter: Id (in path): image identifier (Image)

Actions

Action management.

Property	Type	Description	Comment
Id	Guid		Read-Only, generated
NodeId	Guid
IconId	Guid		Optional
IsValid	Bool	An action is valid when all fields respect rules
LanguageCode	String
Priority	Int?	Allows to sort actions
Order	Int?	Allows to sort actions
Name	String
Style	String	Style, given as a css-like string
Type	String	(see below)
Content	String	Action content-see other doc
DateCreated	DateTime	Read-Only
DateModified	DateTime	Read-Only

Action Type enumeration

RAW
URL
SMS
CALENDAR
EMAIL
MAP
PHONE
VCARD
SHARE

Style
The Style is a free text zone, to be interpreted and understood by the Enriched Images searcher. Onprint smartphone application understands a Json string built as follows. There are 3 parts: the model (identifier so that the app knows how to parse it), the button style (css-like properties, written in Json), and the text style (css-like in Json too).
```
{
  "model":"ONPrint-V2.0",
  "button":{
      "background-color":"#14d22c ",
      "opacity":0.6
  },
  "text":{
      "color":"#ffffff ",
      "font-weight":"normal",
      "font-style":"normal",
      "opacity":1
  }
}
```

GET description

/api/Nodes/{nodeId}/Actions

Parameter: NodeId (in path): node identifier (Node)
Returns: Action list
/api/Nodes/{nodeId}/Languages/{languageCode}/Actions
Parameters:
- NodeId (in path): node identifier (Node)
- LanguageCode (in path): language code (Language)
Returns: Action list
/api/Actions/{id}
Parameter: ActionId (in path): action identifier (Action)
Returns: Single Action

POST and PUT rules

LanguageCode, NodeId are mandatory. Node must be a Document, Image or Zone and have a Title for the provided language (even if it is an empty string). If the action type is empty, it will be set to RAW.

PATCH fields

Can be sent independently: Content, IconId, LanguageCode, Name, NodeId, Order, Priority, Style, Type.
If the Action Type is patched, then the Content must be provided too, and reverse.

DELETE description

/api/Actions/{id}

Parameter: ActionId (in path): action identifier (Action)

DocumentLanguages

The DocumentLanguage is an association between an existing document and an existing language. When creating a new document, a DocumentLanguage is automatically created, with the default language of the document.

Property	Type
DocumentId	Guid
LanguageCode	String

GET description

/api/Documents/{documentId}/DocumentLanguages

Parameter: DocumentId (in path): document identifier (Document)
Returns: List of the Languages of the document

PUT rules

DocumentId and LanguageCode are mandatory.

DELETE description

/api/Documents/{documentId}/DocumentLanguages/{languageCode}

Parameters
- DocumentId (in path): document identifier (Document)
- LanguageCode (in path): language identifier (Language)

Languages

This resource corresponds to the languages in use in the platform. It is read-only.

Property	Type	Description
Code	String
Name	String
Region	String
Zone	String	Geographic zone

GET description

/api/Languages/{code}

Parameter: LanguageCode (in path): language identifier (Language)
Returns: Single language
/api/Languages
Returns: List of all known languages for the application

Icons

Icons are associated to an action, but can be set at any node level. This will allow inheritance and default settings for the documents within a node.

Property	Type	Comment
Id	Guid	Read-Only, generated
NodeId	Guid
Name	String
Tags	String	Comma-separated values in a string
Url	String	Read-Only

GET description

/api/Nodes/{nodeId}/Icons

Parameters:
- NodeId (in path): node identifier (Node)
- inheritance (in url, optional): Boolean to get the properties of the node plus the ones inherited from the parent nodes. If the user has no view right on the parent(s), their Ids are hidden and only show the first 8 characters.
Returns: List of icons that are children of the node
/api/Icons/{id}
Parameter: IconId (in path): icon identifier (Icon)
Returns: Single icon

POST rules

The request body must be Multipart (multipart/form-data). The content is a File data and a Form data.

FileData

The icon image size must be maximum 64x64 pixel.

FormData

Contains the Json query object that goes with the content. It’s an Icon resource, named “icon”. NodeId is mandatory. Example:

 {
   "NodeId": "07b307ea-7253-4114-9ca1-5e367355df4a ",
   "Name": "MyIcon",
   "Tags": "work, telephone, call"
 }

PUT rules

The PUT function needs the IconId as a parameter in the path: PUT api/Icons?iconId=…, and then a file (multipart, as for POST). The role of the PUT function here is just to replace the file. It will not be possible to modify the icon resource. To do so, a PATCH will have to be used.

PATCH fields

Can be sent independently: NodeId, Name, Tags.

DELETE description

/api/Icons/{id}

Parameter: id (in path): icon identifier (Icon)

Titles

A title is associated to an image, document or zone, and a language. It is the title of the element that will be recognized. A title at a higher level than an image will be the default title for the children that are not overridden.
The methods will fail if the node type is other than image, document or zone.

Property	Type
NodeId	Guid
LanguageCode	String
Value	String
Style	String

Title Style
The Style is a free text zone, to be interpreted and understood by the Enriched Images searcher. See its description and example in the Action part.

GET description

/api/Nodes/{nodeId}/Titles

Parameter: nodeId (in path): node identifier (Node: Document, Image or Zone)
Returns: List of children titles of the given node.
/api/Nodes/{nodeId}/{languageCode}/Titles
Parameters:
- nodeId (in path): node identifier (Node: Document, Image or Zone)
- languageCode (in path): language identifier (Language)
Returns: Single title of the given node, for the given language.

POST rules

The POST method is used to create default titles in parent nodes (folders, organizations). Under a document (for a document, image or zone), titles are created either at the document / image / zone creation, or by using the DocumentLanguage resource, using the PUT method with the language. Then, to edit the titles under the document, a PUT will have to be done on each node.
LanguageCode, NodeId, Value are mandatory.

PUT rules

Value is mandatory. LanguageCode and NodeId can’t be modified.

PATCH fields

Can be sent independently: Style, Value.

DELETE description

/api/Nodes/{nodeId}/{languageCode}/Titles

Parameters
- nodeId (in path): node identifier (Node: Document, Image or Zone)
- languageCode (in path): language identifier (Language)

Zones

A Zone is a sub part of an image which can be enriched independently. Creating a zone in an image will deactivate the parent image and activate the child zone. Actions of the original image become global to every zone.

Property	Type	Description	Comment
Id	Guid	Read-Only, generated
ImageId	Guid
Height	Int	Percentage of image size
Width	Int	Percentage of image size
PositionX	Int	Percentage of image size
PositionY	Int	Percentage of image size
Status	String	See Image status	Read-Only
Name	String
ActionCount	Int		Read-Only
Order	Int	Order in image
AutoTrigger	Bool?	Auto trigger of the action. Only if 1 action
SmallThumbnail	String	100px thumbnail	Read-Only
BigThumbnail	String	700px thumbnail	Read-Only
DateCreated	DateTime		Read-Only
DateModified	DateTime		Read-Only

GET description

/api/Images/{imageId}/Zones

Parameter: imageId (in path): image identifier (Image)
Returns: List of children zones of the given image.
/api/Zones/{id}
Parameter: id (in path): zone identifier (Zone)
Returns: Single zone

POST rules

ImageId, PositionX, PositionY, Width, Height are mandatory.

PUT rules

PositionX, PositionY, Width, Height are mandatory. ImageId can’t be modified.

PATCH fields

Can be sent independently: ActionStyle, AutoTrigger, Height, Name, PositionX, PositionY, TitleStyle, Width.

ImagesAndZones

ImageAndZones is an intermediary resource that combines an image with its children zones. It can be accessed the same way as an image, but will have no interest if the image has no zone. This resource is read-only; manipulating zones is directly done through the Zone resource.

Property	Type	Description
Id	Guid
DocumentId	Guid
Status	String	See Image status enumeration
Name	String
ActionCount	Int
ZoneCount	Int
Order	Int	Order in document
AutoTrigger	Bool	Auto trigger of the action. Only if 1 action
SmallThumbnail	String	100px thumbnail
BigThumbnail	String	700px thumbnail
DateCreated	DateTime
DateModified	DateTime
Zones	List	Zone list

GET description

/api/Documents/{documentId}/ImagesAndZones

Parameter: documentId (in path): document identifier (Document)
Returns: List of images that are children of the document, with their zones.
/api/ImagesAndZones/{id}
Parameter: Id (in path): image identifier (Image)
Returns: Single image with its zones.

Files

All the files related to a document: thumbnails and originals. The files are created at the document creation, and can be modified when modifying a document. This endpoint is read-only.

GET description

/api/Documents/{documentId}/Images/{imageId}/files/{size}

Parameters:
- documentId (in path): document identifier (Document)
- imageId (in path): image identifier (image)
- size (in path): pixel size of the biggest thumbnail size needed
Returns: An URL pointing to the image thumbnail for the given image, at the desired size. (content is a single string)
/api/Documents/{documentId}/Original
Parameter: DocumentId (in path): document identifier (Document)
Returns: An URL pointing to the original document file (single image or PDF) (content is a single string)

Scan of Enriched Images

EnrichedImages

This resource is a full image used for recognition and getting actions associated to an image. It contains everything that is needed to use onprint from a mobile device.

Property	Type	Description
Id	Guid
BigThumbnailUrl	String	Big thumbnail URL (700px)
LanguageCode	String
Title	String	Image title
DocumentId	Guid
SessionId	String	Session Id: is set by the server
Order	Int	Image order in document
AutoTrigger	Bool	Auto trigger of the action Only if 1 action
TitleStyle	String
Data	String	This field will always be empty, except when you scan a Picture, therefore you will have no Title, no Actions, no LanguageCode, no Styles.
Actions	List

ActionMobile

Read-Only resource, only contained in EnrichedImages.

Property	Type	Description
Id	Guid
Icon	String	Icon URL
Priority	Int
Order	Int
Name	String
Style	String
Type	String	See action type enumeration
Content	String

Headers

To use any method for this resource, the following headers are required:

Header	Mandatory?
SessionId
ApplicationInstanceId
ApplicationName	*
ApplicationVersion	*
ApiKey	*
DeviceName	*
DeviceSystemVersion	*
DeviceSystemVersionName
SdkName
SdkVersion	*
DeviceConnectivity
DeviceScreenDiagonal
DeviceScreenHeight
DeviceScreenWidth

If SessionId is null, it will be initialized by the server and given back in the EnrichedImage.

GET description

/api/EnrichedImages/{id}

Parameters:
- id (in path): image identifier (Image)
- LanguageCode (in query url): language identifier (Language)
Returns: Enriched image: the image with its actions in the language given in parameter

POST description

The POST method here is used as a search query, to search an image using image recognition. The request body content type must be Multipart (multipart/form-data). The content is made of a File data and a Form data.

FileData

Contains the image file of the picture taken (image/jpeg content type). The picture can be compressed, put in black&white and pre-treated to ease image recognition.

FormData

Contains the Json query object that goes with the content. The parameter only contains one property: Language (string) containing a language code. The form data name is “query”. Example:

 {
     "Language":"fr-FR"
 }

Response

The response is the enriched image with localized actions. Here is an example:

 {
   "Id": "712816b1-ae76-47fb-801f-a54b49378fb5",
   "BigThumbnailUrl": "http://toto.com/bigthumb.jpg",
   "LanguageCode": "fr-FR",
   "Title": "Tout sur les Poissons",
   "DocumentId": "07b307ea-7253-4114-9ca1-5e367355df4a",
   "SessionId": "140cc120-e78a-4039-aef4-1b4b20436a58",
   "Order": 1,
   "AutoTrigger": true,
   "Actions": [{
       "Id": "1e60ce69-32e8-45b7-8655-36a1361ce4bc",
       "Icon": "http://toto.com/icon.jpg",
       "Priority": 2,
       "Order": 8,
       "Name": "Nous rejoindre",
       "Type": "URL",
       "Content": "{
         \"Url\": \"http://www.onprint.com\",
         \"IsEmbeddedWebView\": \"true\",
         \"IsAnonymousURL\": \"true\",
         \“ContentType\”:\”text/html\”}"
     }]
 }

The content parameter types are described in another document.

Clicks

A click is an event resource that is used to track a click of a user on a given action. The most common use case is the smartphone application: the click is called after an image recognition and action listing, when the user taps on an action. The click is stateless, write-only.

Headers

To use this method, the following headers are required:

Header	Mandatory?
SessionId	*
ApiKey	*

If SessionId is null, it will be initialized by the server.

PUT rules

The PUT method is simply called with the Action identifier in the URL: PUT /api/clicks?actionId=…

Clickstream and statistics

Matches

Through this resource you can access information about the search requests made against a document.

Property	Type	Description
RequestTime	DateTime
DeviceSystemVersion	String
Language	String	Language code
Operating System	String
ImageOrder	Int	Order of image in document
DocumentName	String
Host	String	IP of caller
Clicks	List	Clicks associated to the match

Clicks

Read-Only resource, only contained in Matches.

Property	Type	Description
ClickTime	DateTime
Host	String	IP of caller
ActionName	String
ActionOrder	Int	Order of action in image
ActionType	String
ActionId	Guid

GET description

/api/Matches?documentId=…

Parameter: documentId (in request): document identifier (Document)
Returns: Match

User Management

Roles

Roles are associated to rights management and permissions of a user. It is not possible to add a new role. The PUT method allows to associate a User to a known role.

Property	Type	Description
Role	String	Nom du rôle*

Role enumeration

Administrator
CustomerAccountManager
Designer
GET description

/api/Roles
Returns All known roles
/api/Users/{userId}/Roles
Parameter: userId (in path): user identifier (User)
Returns: List of roles associated to the user.

PUT rules

The PUT method needs the userId and the role name as parameters in the path, and no content: PUT api/Users/{userId}/Roles/{role}. Example: PUT /api/Users/123456/Roles/Designer

DELETE description

/api/Users/{userId}/Roles/{role}

Parameters:
- userId (in path): user identifier (User)
- role (in path): role string value

Users

Management of the platform users. A user is attached to an organization.

Property	Type	Description	Comment
Id	Guid		Read-Only, generated
OrganizationId	Guid
UserName	String
Mail	String	e-mail address
FirstName	String
LastName	String
Password	String
Status	String	(see below)
Gender	String	(see below)

User Status enumeration

Inactive
Active

User Gender enumeration
Unspecified
Other
Man
Woman
GET description

/api/Organizations/{organizationId}/Users
Parameter: organizationId (in path): organization identifier (Organization)
Returns: List of users of the given organization.
/api/Users?username=…
Parameter: username (in URL): user login name (User)
Returns: Single user
/api/Users/{id}
Parameter: Id (in path): user identifier (User)
Returns: Single user

POST rules

OrganizationId, Mail are mandatory. If provided Username is NULL, Mail address will be copied into Username.

PUT rules

OrganizationId, Mail are mandatory. PUT does not update Password. If provided Username is NULL, Mail address will be copied into Username.

PATCH fields

Can be sent independently: Status, Password.

DELETE description

/api/Users/{id}

Parameter: Id (in path): user identifier (User)

Account

An organization’s account, created after the organization creation. RemainingCredit depends on the contract type. The other fields are counters. This resource is read-only.

Property	Type	Description
OrganizationId	Guid
ValidityDate	DateTime	End of contract date
ActivePages	Int	Number of active pages
ActivationCumul	Int	Number of pages that have been activated at least once
AccountType	String	(see below)
RemainingCredit	int	Remaining pages to activate

Account Type enumeration

YearlySubscription: the organization is not billed on page number, but on a year basis subscription.
ActivePages: a price is set for the number of active pages at a given time. When deactivating page, the remaining page credit increases.
ActivationCumul: a price is set for the number of activations. The credit is consumed once, and is not given back when deactivating a doc.
GET description

/api/Account
Parameter: OrganizationId (in url): organization identifier (Organization).
Returns: Single Account

Credits

A credit is an event resource that means a transaction between a source and a target. The source is the organization of the user that is logged in, the target is the organization identifier given in the Json parameter. To give or take credits, the user must have sufficient rights on the source and on the target organizations. The credit transaction is stateless, write-only.

Property	Type
OrganizationId	Guid
Amount	Guid
Direction	String

Credit Direction enumeration

Debit: “take”: the credit amount is taken from the target (parameter org), and given to the source (user org)
Credit: “give”: the credit amount is taken from the source (user org), and given to the target (parameter org).
PUT rules
OrganizationId, Amount and Direction are all mandatory.

Logo

The Logo is associated to an organization. It is used for platform client display. It can only be set or deleted from here, and its URL is available in the organization resource properties.

PUT rules

The request body content type must be Multipart (multipart/form-data). It needs the OrganizationId as a parameter in the path: PUT api/Logo/{id} and a File Data. In File data, the logo can be any image type (png, jpg, gif).

DELETE description

/api/Logo/{id}

Parameter: Id (in path): organization identifier (Organization)

Node Hierarchy

Organizations

An organization represents a customer (company or individual). It’s the main node of a document hierarchy.

Property	Type	Description	Comment
Id	Guid		Read-Only, generated
ParentId	Guid?	NodeId (parent)
Logo	String	Logo URL	Read-Only
LanguageCode	String
Name	String
ApiKey	String	API Key, used for WebAPI calls	Read-Only
AccountType	String	See account type enumeration	Read-Only
MobileApiAuthorized	Bool	Mobile can reach the API	Read-Only
WebApiAuthorized	Bool	Any API access	Read-Only
IRProviderId	Guid	Id and access details of IR Provider	Read-Only
ActivationCumul	Int	See account resource	Read-Only
DeactivationCumul	Int		Read-Only
TotalDebit	Int		Read-Only
TotalCredit	Int		Read-Only
DateCreated	DateTime		Read-Only
DateModified	DateTime		Read-Only
PicturesCount	Int?	Pictures Counter, only for organizations in Pictures mode. Updated when option GetPicturesCount is True in GET Organizations/Id.	Read-Only

GET description

/api/Nodes/{nodeId}/Organizations

Parameter: nodeId (in path): node identifier (Node)
Returns: List of children organizations of the given node.
/api/Organizations/{id}
Parameter: id (in path): organization identifier (Organization)
Parameter: activationCumul (bool, in URL): will calculate the counters (Activation Cumul, Deactivation Cumul, Total Debit, Total Credit) cumulating child nodes.
Parameter: getPicturesCount (bool, in URL): will calculate - update and return Pictures Count, if any Pictures in the organization.
Returns: Single organization

POST and PUT rules

LanguageCode, Name, ParentId are mandatory.

PATCH fields

Can be sent independently: LanguageCode, Name, ParentId.

DELETE description

/api/Organizations/{id}

Parameter: Id (in path): organization identifier (Organization)

Special fields

AccountType, IRProviderId, MobileApiAuthorized and WebApiAuthorized are special fields that require ONprint input and cannot be set / modified. Contact us for more information.

Folders

Folder management.

Property	Type	Description	Comment
Id	Guid		Read-Only, generated
ParentId	Guid	NodeId
Name	String
DateCreated	DateTime		Read-Only
DateModified	DateTime		Read-Only

GET description

/api/Nodes/{nodeId}/Folders

Parameter: NodeId (in path): node identifier (Node)
Returns! List of folders that are children of the node
/api/Folders/{id}
Parameter: FolderId (in path): folder identifier (Folder)
Returns: Single folder

POST and PUT rules

Name and ParentId are mandatory.

PATCH fields

Can be sent independently: Name, ParentId.

DELETE description

/api/Folders/{id}

Parameter: FolderId (in path): folder identifier (Folder)

Nodes

A node is an element of arborescence that hierarchically organizes Organizations, Folders, Documents, Images and Zones. It contains no information but the hierarchy of nodes. Nodes are systematically created among with Organizations, Folders, Documents, Images and Zones.

Property	Type
Id	Guid
Type	String
ParentId	Guid
Name	String

Node Type enumeration

Document
Organization
Folder
GET description

/api/Nodes/{id}/Nodes
Parameter: id (in path): node identifier (Node)
Returns: List of children nodes which parent is the one given in parameter.

Properties

Properties define default behavior for nodes. Today it only concerns default Icon or default Style. Behavior of properties is different for icon properties and style properties. For an icon, it is only stored, not used by the server and not provided in the list of icons in the node. For a style, the information is used by the server. The style is automatically set for all the children titles or actions, existing or new, when there is no other defined style in the hierarchy.

Property	Type	Comment
Id	Guid	Read-Only, generated
NodeId	Guid
Type	String
Name	String
Value	String

Property Type enumeration

Style (see how the Style value is built in the Action part)
Icon

Property Name constraint
If Property Type is “Style”, Property name must be one of the following. It indicates whether the property sets a default ActionStyle or a default TitleStyle:
Action
Title
GET description

/api/Nodes/{nodeId}/Properties
Parameters:
- nodeId (in path): node identifier (Node)
- type (in url, optional): type identifier, to only get properties of the given type
- inheritance (in url, optional): Boolean to get the properties of the node plus the ones inherited from the parent nodes. If the user has no view right on the parent(s), their Ids are hidden and only show the first 8 characters.
Returns: List of children properties of the given node.
/api/Properties/{id}
Parameter: Id (in path): property identifier (Property)
Returns: Single property

POST and PUT rules

NodeId, Type and Name are mandatory.

PATCH fields

Can be sent independently: Name, Value.

DELETE description

/api/Properties/{id}

Parameter: Id (in path): property identifier (Property)

History

History Node Management.

Property	Type
Date	DateTime
User	String
Operation *	String

Operation enumeration
CREATE
ACTIVATION (Document only)
DEACTIVATION (Document only)
MOVE
RENAME
REPLACE (Document only)
UPDATE
MIGRATION

GET description

/api/Nodes/{nodeId}/History

Parameter: NodeId (in path): node identifier (Node)
Returns: List of history of the node

Core Image Recognition

Sometimes, you will only need the Platform to identify an image, not to enrich it with actions, languages and styles. There are entry points for that. You only need a login, an OrganizationId (you get it when you log in), and an API Key for searching. This part is optimized for High Volumes / High Speed image recognition. No image is stored in the platform, and data is indexed in a fast database.

Pictures

A Picture is a simple, single Image. It is not compatible with the whole Node hierarchy and cannot be into a Document, nor listed in a Folder. There cannot be Zones in it. It is only linked to an Organization.

Property	Mandatory?	Type	Description	Comment
Id		String	Picture Id in the platform.	Read-Only, generated
_objectId		String	Internal Id, useful for pagination (see )	Read-Only, generated
Name	*	String	Picture name. Can be your own identifier
Data		String	Picture metadata. You can put whatever you want, in any format.
OrganizationId	*	String	Organization's Id. Pictures will be listed under it.
BigThumbnailUrl		String	URL of the Picture's Thumbnail. (only for display)	Read-Only, generated
SessionId		String	Session identifier that you can use to link events to the IR.	Read-Only, generated
RecognitionScore		String	Score of the image recognition, regarding the query image.	Read-Only
Keywords		String[]	Keywords attached to the picture, to filter searches.

GET description

/api/Pictures/{id}

Parameter: Id (in path): picture identifier (Picture)
Returns: Single picture

/api/Organizations/{id}/Pictures

/api/Organizations/{id}/Pictures?lastId={lastId}&limit={limit}&reverseOrder={reverseOrder}

Parameters:
- Id (in path): organization identifier (Organization)
- lastId (in URL, optional): the last Picture's __objectId_ previously received. For pagination. The next set of results will then be returned. If no lastId is provided, the results will be the first page.
- limit (in URL, optional): maximum number of results. If no limit is provided or if the limit is 0, the 50 first pictures will be returned.
- reverseOrder (in URL, optional): true if you need to get the list in reverse order (most recent first). In this case, always set it in the query, and the lastId will have to be the smallest __objectId_.
Returns: List of Pictures under an organization. LastId and Limit are used for Pagination. The __objectIds_ are ordered.

POST rules

The POST method is used to create a picture by sending the image file and its properties. The request body content type must be Multipart (multipart/form-data). The content is made of a File data (file) and a Form data (picture).

FileData (file)

The image itself. It can be a JPEG, PNG, or GIF image. The MIME type has to be given in the file content type.

FormData (picture)

Contains a Picture object. The form data name is picture. Name and OrganizationId are mandatory. If you don't know where to find an OrganizationId, yours is in the token when you log in.

PUT description

Calling PUT /api/Pictures with an existing updated Picture in the body will only update its Name, Data and Keywords.

PATCH description

Calling PATCH /api/Pictures with an existing updated Picture in the body can update its Name, Data and Keywords, if a value is entered for each.

DELETE description

/api/Pictures/{id}

Parameter: Id (in path): picture identifier (Picture) Delete cannot be undone!

SEARCH (POST) rules

api/Pictures/Search

The POST method on SEARCH is used to query the image for recognition. The request body content type must be Multipart (multipart/form-data). The content is made of a File data (file) and a Form data (query), currently left empty. This method does not require authentication but the following headers:

Header	Mandatory?
ApplicationInstanceId
ApplicationName	*
ApplicationVersion	*
ApiKey	*
DeviceName	*
DeviceSystemVersion	*
DeviceSystemVersionName
SdkName
SdkVersion	*
DeviceConnectivity
DeviceScreenDiagonal
DeviceScreenHeight
DeviceScreenWidth

FileData (file)

The query image itself. It can be a JPEG, PNG, or GIF image. The MIME type has to be given in the file content type.

FormData (query)

Please send also a query consisting of an empty form { }. The form data name is query. A query object to precise / filter results. Currently it consists of adding the picture's keywords as a Json:

{
    Keywords:["keyword1", "keyword2"]
}

Returns

The Search returns a list of pictures matching the query image and, if there are, the keywords. Every matching Picture is returned with its RecognitionScore between 0 and 1, the highest being 1.

Onprint API Documentation

Getting started

Authentication

Token

POST /token

Header for API calls

Endpoints that do not require authentication

User rights and roles, node hierarchy

Node hierarchy

User roles

Return codes

Success

200 OK

201 Created

204 No Content

Client Error

400 Bad Request

401 Unauthorized

403 Forbidden

404 Not Found

Server Error

500 Internal Server Error

Image Enrichment

Documents

GET description

/api/Nodes/{nodeId}/Documents

/api/Documents/{id}

POST rules

Async parameter

FileData (file)

FormData (document)

PUT method

FileData (file)

PATCH fields

DELETE description

/api/Documents/{id}

Images

GET description

/api/Documents/{documentId}/Images

/api/Images/{id}

PUT rules

PATCH fields

DELETE description

/api/Images/{id}

Actions

GET description

/api/Nodes/{nodeId}/Actions

/api/Nodes/{nodeId}/Languages/{languageCode}/Actions

/api/Actions/{id}

POST and PUT rules

PATCH fields

DELETE description

/api/Actions/{id}

DocumentLanguages

GET description

/api/Documents/{documentId}/DocumentLanguages

PUT rules

DELETE description

/api/Documents/{documentId}/DocumentLanguages/{languageCode}

Languages

GET description

/api/Languages/{code}

/api/Languages

Icons

GET description

/api/Nodes/{nodeId}/Icons

/api/Icons/{id}

POST rules

FileData

FormData

PUT rules

PATCH fields

DELETE description

/api/Icons/{id}

Titles

GET description

/api/Nodes/{nodeId}/Titles

/api/Nodes/{nodeId}/{languageCode}/Titles

POST rules

PUT rules