25.1.0 API Changelog

Breaking changes

Attachments limits

We added hard attachment limit of 20 per document. Total size is now also limited to 5*dropZoneMaxSize(by default this is 5*40 => 200MB) or 1GB whichever value is smaller.

Owner

In documents there is now property called owner. Owner has ability to do addition actions with document (e.g. send share reminder). There is also possibility to transfer this ownership if this feature is enabled (PUT /documents/owner). This mechanism will be further improved in future version(s).

Reminders

We have added an option to send reminder using SMS. SMS reminders con only be send manually (no auto-remind using SMS) and it required a change to reminder endpoint (POST /share/reminder). First you can only use SMS when you have SMS addon. Also you have to call endpoint using shares and not just document ID because we need phone numbers to associate to shares to send those notifications.

POST /share/reminder
{
  "reminderType": "sms",  //sms or email (default)
  "shares": [             //array or shares and phone you wish to notify
    {
      "shareId": "abc123",
      "phone": "+000123456789"
    }
  ]
}

All params moved from query to body

Stamps

Stamps resources were added. We used to handle stamps as part of users resources. Now we have introduced. Organization stamps so a a part of this new feature stamps were separated to their own resources. Added endpoints:

• GET /stamps/{id} - get stamp by its ID

• POST /stamps - create new stamp

• POST /stamps/search - search in stamps (fetch multiple)

• PUT /stamps/{id} - edit stamp

• DELETE /stamps/{id} - delete stamp

In endpoint where you used to send stamp image you now sent stamp ID. As it was mentioned there is also completely new feature orrganization stamps. These stamps can be accessed by authorized users and should be used as team/department stamps e.g. financial depertment stamp.

As a related change some endpoint in share resources needed to be changed too. This includes:

• POST /share/upload/stamp - you still provide image, but returened value is no longer a file hash but stamp ID, you can use it to get stamp image usgin endpoint bellow

• GET /share/stamp/{id} - returns image uploaded as stamp using endpoint above

Login

• The endpoint GET /login now returns status 200 with an object { logged: false } when no token is sent.

WOPI

• Updated endpoint GET /wopi/extensions to return an object with properties client (string WOPI client type) and extensions (array with string extensions supported by the WOPI client).

Non-breaking changes

Minified API

To remove some clutter and make API more accessible we have created minified version of our API. URLs are always the same but minified API contains less properties and it only includes most used endoints so you can easily find what is important for you. It also comes with greatly improved documentation so its even easier to integrate Circularo into your app. You still have possibility to assess “full” API but we believe that minified API will be sufficient for most use-cases.

Optionally return token in the content body

Added optional parameter returnToken (default true) to the endpoints GET /login, POST /login and PUT /users/activate. When set to false, the endpoint won’t return the token in the content body.

After two versions, we will change the default value to false to prevent token exposure without a request. Make sure you implement this change if you haven’t already started using cookies.

DSS validation

We added optional DSS (Digital Signature Services) validation to our verify resources. They all now contain query parameter dss (false by default). If you enable this in addition to existing data you will also get new validation data. Each of these properties is string containg XML.

{
    ...existing properties,
    "dss": {
      "simpleReport": "<xml>",
      "detailedReport": "<xml>",
      "diagnosticData": "<xml>",
      "validationReport": "<xml>"
    }
}

Separated lite and regular users in group info

When searching for groups (POST /groups/search) with includeUserCountflag set we have separated user counts of “regular” and lite users:

{
    "_id": "9bd60cb0-2b72-474d-a334-9b446e110cad",
    "version": 1,
    "displayName": [
        {
            "language": "en",
            "value": "Business Organization"
        }
    ],
    "edition": "business",
    "subscription": "AefsYZUBmvIz_dFpkdB2",
    "name": "9bd60cb0-2b72-474d-a334-9b446e110cad",
    "organization": "9bd60cb0-2b72-474d-a334-9b446e110cad",
    "organizationGroups": {
        //group IDs
    },
    "type": [
        "organization"
    ],
    "subscriptionObj": {
        //subscription info
    },
    "userCount": 7,
    "liteUserCount": 0
}

Now userCount contains only admins and members and liteUserCount includes rest (read, prepare, sign).

Public attachments

When uploading attachment to document you can now choose if it will be public. Public means that if you share doument outside of an organization that this attachment will still be visible. You can use it send some additional details abou main document. If its not maked as public (current + default behavior) it can only be seen by other members of organization but not in external share.