Monoly Core is an enterprise-grade trust network that enables both internal and external entities to communicate and collaborate with each other while retaining the complete ownership and control of their data.
\nIt provides RESTFul Open APIs to integrate the Monoly technology into an existing or a new product (be it enterprise or cloud based).
\nUnlike most of the existing enterprise communication solutions where user data is stored in a centralized service, Monoly Core does not get involved in the enterprise users’ data exchange loop while powering up the entire service trustworthy.
\nIt defines the trust governance framework which enables secure peer to peer communication between trusted enterprise nodes.
\nTo use Monoly Core, create a developer account on web portal.Developers can use their email address to create a developer account.
\nOnce registered, developers can sign-in to developer portal using their registered email address and the chosen password.Successful login will take the user to developers' home page.In case the developer has forgotten the password, it can be easily reset using the registered email address during Sign-in stage.
\nDeveloper portal offers a sandbox development environment, in the cloud, running Monoly Core's service nodes. It provides an opportunity for developers to develop, integrate and test their applications with actual core nodes without worrying about setting up the infrastructure for running such nodes.
While creating a developer account, one development environment gets created by default. If developers require more than one environment, they can create them via `developer portal `_.
An API key is a token that a client provides when making API calls. Developers use API Keys to access Monoly Core API. These represent the required credentials and also identify the application which is using the Core API. API key ensure that only the authorized applications access the Core nodes.
\nDevelopers can create and manage API keys from their developers portal. Each development or production environment requires a separate API key.
\nYou can manage the API key for accessing your development environment from developer portal. Against each development environment, you can create API key, rotate it or take other actions.
For production environment, API key can be managed from respective enterprise admin portal.
To create an API key:
\n* Login in to developer portal using your credentials
* Go to respective development environment section for which you need to create API key
* Click Generate API key to create a new API key
* Monoly Core API returns 401 Unauthorized response for requests with missing or invalid API key.
* API keys are supposed to be a secret that only the client and server know.
* Like basic authentication, API key-based authentication is only considered secure if used together with other security mechanisms such as HTTPS/SSL.
* Do not embed API keys directly in code. API keys that are embedded in code can be accidentally exposed to the public.
* Do not store API keys in files inside your application's source tree.
* Delete unneeded API keys to minimize exposure to attacks.
* Rotate your API keys periodically.
In order to register a user on Monoly service, CID (Company ID) and UID (User ID) are required. In case of the development environment, the developer receives the CID and UID on creating a new development environment via developers' portal. In case of production environment, the enterprise receives the CID and requested list of UIDs from Monoly Inc. via some out of band mechanism such as email.
\nAs a first step, the enterprise assigns an un-used UID, from the list of received UIDs, to a given user via some out of band mechanism such as email
\nThis API handles registion of user's email id against the assigned UID.
\n","urlObject":{"path":["ent","v1","uids",":uid","account"],"query":[],"variable":[{"description":{"content":"(Required) The UID assigned to the enterprise user
\n","type":"text/plain"},"type":"any","value":"{uid}","key":"uid"}]}},"response":[{"id":"fc239f59-4562-4c24-925e-049e8c051fce","name":"OKThe API method is used to update the email validation status of the user when terms and conditions are accepted by the user.
\n","urlObject":{"path":["ent","v1","uids",":uid","account"],"query":[],"variable":[{"description":{"content":"(Required) The UID assigned to the enterprise user
\n","type":"text/plain"},"type":"any","value":"{uid}","key":"uid"}]}},"response":[{"id":"1d27533b-50c2-45cd-8681-7dd8b6d724c4","name":"OKUpdate user account details like screen name and credentials (username and password).
\n","urlObject":{"path":["ent","v1","uids",":uid","account"],"query":[],"variable":[{"description":{"content":"(Required) The UID assigned to the enterprise user
\n","type":"text/plain"},"type":"any","value":"{uid}","key":"uid"}]}},"response":[{"id":"f3ff65d2-62a9-43a1-a2f8-4a649b48cc71","name":"OKThie API represents users' email activation end-point. On successful validation, it loads the Terms and Conditions Page with user context.
\n","urlObject":{"path":["ent","v1","uids",":uid","account","verify"],"query":[],"variable":[{"description":{"content":"(Required) The UID assigned to the enterprise user
\n","type":"text/plain"},"type":"any","value":"{uid}","key":"uid"}]}},"response":[{"id":"3b5f3ea7-b53a-463f-b6ef-ee08db691990","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":"This API is used to resend the activation email for given user.
\n","urlObject":{"path":["ent","v1","uids",":uid","account","resend-activation"],"query":[],"variable":[{"description":{"content":"(Required) The UID assigned to the enterprise user
\n","type":"text/plain"},"type":"any","value":"{uid}","key":"uid"}]}},"response":[{"id":"84c0f574-c9ef-40bc-8f3b-7242de38292c","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":"This API checks if the provided screen-name is available for use or is already occupied and can't be used
\n","urlObject":{"path":["ent","v1","user","screen-name",":screenname"],"query":[],"variable":[{"description":{"content":"(Required) The UID assigned to the enterprise user
\n","type":"text/plain"},"type":"any","value":"{uid}","key":"screenname"}]}},"response":[{"id":"55b443d2-3f7a-4a06-b479-9e4c11a8a44d","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":"The API is used to create user account on monoly service.
\n","urlObject":{"path":["ent","v1","user","create-account"],"query":[],"variable":[]}},"response":[{"id":"626af4e8-5249-4787-b26e-62707b4a199b","name":"OK","originalRequest":{"method":"POST","header":[{"description":"(Required) an authorization header","key":"API-KEY","value":"In order to register a user on Monoly service, CID (Company ID) and UID (User ID) are required. In case of the development environment, the developer receives the CID and UID on creating a new development environment via developers' portal. In case of production environment, the enterprise receives the CID and requested list of UIDs from Monoly Inc. via some out of band mechanism such as email.
\nAs a first step, the enterprise assigns an un-used UID, from the list of received UIDs, to a given user via some out of band mechanism such as email. Here is an example of implementing registration using email.
\nOnce the user has created her account on Monoly Core enterprise backend service, she can login to access the service using her username and password.
\nOn successful login, the login API returns a bearer token containing the user context. This token has to be passed to the backend service in subsequent API to identify the user context; otherwise the API would return authorization failure.
\n","event":[{"listen":"prerequest","script":{"id":"ba0bde1f-52fa-4c44-a738-27a8563110f1","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"767b0947-64e5-4142-927f-853ab457ff9c","type":"text/javascript","exec":[""]}}],"_postman_id":"2ed62061-c2b5-4004-b94b-68a3a4bc1c0c"},{"name":"User Login / Logout","item":[{"name":"/ent/v1/user/login","id":"5427f992-0362-4502-beca-f12048ddf44d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"The API is used to authenticate the user to Monoly fabics' enterprise backend service
\n","urlObject":{"path":["ent","v1","user","login"],"query":[],"variable":[]}},"response":[{"id":"1bc9e509-35a6-4158-8a42-03c84ccd711f","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":"This API is used to logout the user session.
\n","urlObject":{"path":["ent","v1","user","logout"],"query":[],"variable":[]}},"response":[{"id":"523d2faf-e9b7-4107-842e-df1258bfcfb4","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":"Once the user has created her account on Monoly Core enterprise backend service, she can login to access the service using her username and password.
\nOn successful login, the login API returns a bearer token containing the user context. This token has to be passed to the backend service in subsequent API to identify the user context; otherwise the API would return authorization failure.
\nFollowing API are used to login or logout a user from Monoly service.
\n","_postman_id":"f842a9ea-202c-4c0c-b4c8-a9bc3d638c1b"},{"name":"Discussion","item":[{"name":"Discussions","item":[{"name":"/ent/v1/user-type","id":"6fa5959b-ef9d-4bc8-9da1-62d50d84b237","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This API is used to get the user or member type (internal/external/guest) by email before adding it to a channel
Note: The UID of inviter shall be extracted by the monoly backend from the bearer token
(Required) Comma separated list of user emails
\n","type":"text/plain"},"key":"user-emails","value":"xyz@example.com"}],"variable":[]}},"response":[{"id":"57ca445e-a0a3-4155-99f9-fadde3e87e02","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerThis API is used to create a discussion with user list and discussion attributes.
This API is also used to add the members to an existing discussion by sending the discussion ID in the request body.
Note: The UID shall be extracted by the monoly backend from the bearer token
This API shall return information related to all the given user. The API also returns the information of unread notifications, unread posts and last post metadata of the discussions. The unread information can be consumed to highlight the discussions to the user.
Note: The UID shall be extracted by the monoly backend from the bearer token
Filter type. Possible values: ('id', 'name')
\n","type":"text/plain"},"key":"type","value":"id"},{"description":{"content":"Filter value. Possible values could be 'channel-id' or 'channel-name'
\n","type":"text/plain"},"key":"value","value":"dde1ebe1-69b5-48b2-8ec3-ab2ba1f316c3"}],"variable":[]}},"response":[{"id":"88114ece-0ac6-4f78-bdc1-8786affadb24","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerThis API is used to delete the given Channel.
Note: The UID shall be extracted by the monoly backend from the bearer token
(Required) ID assigned to the channel during its creation
\n","type":"text/plain"},"type":"any","value":"adipisicing c","key":"channel-id"}]}},"response":[{"id":"c3c4efca-de58-4cba-935f-d9625e232dee","name":"OK","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerThis API is used to update channel details like name, description etc.
Note: The UID shall be extracted by the monoly backend from the bearer token
(Required) ID assigned to the channel during its creation
\n","type":"text/plain"},"type":"any","value":"adipisicing c","key":"channel-id"}]}},"response":[{"id":"c9f66274-3d27-40e2-a476-e9513c512d4c","name":"The request is successfully processed","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerThis API is used to get the topci of the given Channel.
Note: The UID shall be extracted by the monoly backend from the bearer token
(Required) ID assigned to the channel during its creation
\n","type":"text/plain"},"type":"any","value":"adipisicing c","key":"channel-id"}]}},"response":[{"id":"d6f4591c-cfab-416a-960e-f7c6d96bbaa4","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerThis API is used to update channel topic.
Note: The UID shall be extracted by the monoly backend from the bearer token
(Required) ID assigned to the channel during its creation
\n","type":"text/plain"},"type":"any","value":"adipisicing c","key":"channel-id"}]}},"response":[{"id":"e31637eb-e41e-4364-a0f9-e75269f33890","name":"The request is successfully processed","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerThis API is used to delete the topic of a given Channel.
Note: The UID shall be extracted by the monoly backend from the bearer token
(Required) ID assigned to the channel during its creation
\n","type":"text/plain"},"type":"any","value":"adipisicing c","key":"channel-id"}]}},"response":[{"id":"e24a40b3-b6fa-4598-a86f-3299b54cd609","name":"The request is successfully processed","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerThis API is used to create a discussion with user list and discussion attributes.
This API is also used to add the members to an existing discussion by sending the discussion ID in the request body.
Note: The UID shall be extracted by the monoly backend from the bearer token
API to Get the global member list, i.e., all the users associated with all discussion of logged-in user.
Note: The UID shall be extracted by the monoly backend from the bearer token
This API shall return information related to all the members or a given member for a given channel. Member name or id can be provided as query string parameter. If nothing is provided on the query string then information about all the members shall be fetched for given channel.
Note: The UID shall be extracted by the monoly backend from the bearer token
Filter type. Possible values: ('id', 'name')
\n","type":"text/plain"},"key":"type","value":"adipisicing c"},{"description":{"content":"Filter value. Possible values could be 'user-id' or 'user-name'
\n","type":"text/plain"},"key":"value","value":"adipisicing c"}],"variable":[{"id":"241afcb4-8733-4147-b1bf-d0d1aee9adb2","description":{"content":"(Required) ID assigned to the channel during its creation
\n","type":"text/plain"},"type":"any","value":"adipisicing c","key":"channel-id"}]}},"response":[{"id":"6de8f184-0235-4d98-bb5c-8ab4d7f1d0f1","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerThis API is used to delete the given member from the given channel.
Note: The UID shall be extracted by the monoly backend from the bearer token
(Required) ID of the member to be deleted
\n","type":"text/plain"},"key":"userId","value":"adipisicing c"}],"variable":[{"id":"3813a3cb-139a-4f36-b176-bd73a11b8f8d","description":{"content":"(Required) ID assigned to the channel during its creation
\n","type":"text/plain"},"type":"any","value":"adipisicing c","key":"channel-id"}]}},"response":[{"id":"ed7c2584-145c-4f64-811f-e6a625615d7c","name":"OK","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerMonoly assembles conversations into ‘discussions' where most of the activities happen such as:
\nThis API creates a new collection for the given user.
[Note] User ID is extracted from the API token
The API returns the following:
The API returns the information related to given collection including the list of discussions mapped to it
\n","urlObject":{"path":["ent","v1","collection",":id"],"query":[],"variable":[{"id":"d3efb079-aaa3-4871-8090-551fd1c133fc","description":{"content":"(Required) Collection ID
\n","type":"text/plain"},"type":"any","value":"deserunt","key":"id"}]}},"response":[{"id":"34ed61c7-4ad0-43f3-a12f-c7ceeb89bf53","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":"This API updates the collection name and/or description
\n","urlObject":{"path":["ent","v1","collection",":id"],"query":[],"variable":[{"id":"e50b3038-7e01-4407-a5d0-3d98147693c7","description":{"content":"(Required) id where collection to be deleted
\n","type":"text/plain"},"type":"any","value":"deserunt","key":"id"}]}},"response":[{"id":"6ff3587f-5e6a-40af-8460-243d7ee33994","name":"The request is successfully processed","originalRequest":{"method":"PATCH","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":"This API is used to delete the user collection by ID
\n","urlObject":{"path":["ent","v1","collection",":id"],"query":[],"variable":[{"id":"1c0d6f5f-e43e-41b6-8363-4f0fc83c4cd7","description":{"content":"(Required) ID of the collection to be deleted
\n","type":"text/plain"},"type":"any","value":"deserunt","key":"id"}]}},"response":[{"id":"6ae215b0-752f-4e84-bb84-324317c05bfc","name":"The request is successfully processed","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":"API creates/updates the mapping of discussions to collection(s)
\n","urlObject":{"path":["ent","v1","channel","ids",":id","collections"],"query":[],"variable":[{"id":"d6150598-adc4-4bb6-a32b-c8cb6072daa2","description":{"content":"(Required) Discussion (channel) ID which should be mapped to the list of collections
\n","type":"text/plain"},"type":"any","value":"deserunt","key":"id"}]}},"response":[{"id":"00349203-251f-4263-9d99-ff80b661bd2a","name":"The request is successfully processed","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":"This API is used to remove the discussion from collection on \"Delete\" operation.
\n","urlObject":{"path":["ent","v1","channel","ids",":id","collections",":id"],"query":[],"variable":[{"id":"bb703bde-dd78-46a3-89f4-d9fd92675754","description":{"content":"(Required) id where collection to be deleted
\n","type":"text/plain"},"type":"any","value":"deserunt","key":"id"}]}},"response":[{"id":"32ed2bc3-d1eb-4ca8-85e1-deab274a025a","name":"The request is successfully processed","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":"Discussions can further be organized into ‘Collections’ which is group of one or more discussions. It helps the users to organize their discussions in a more logical and cleaner way. Collections are user specific; collections created by a user are not visible to another user.
By default all discussions are part of a default collection named ‘Discussion’. It contains all the discussions either created by the user or ones to which user has been invited to.
User can create, rename or delete a collection. Any existing discussion can be moved to any collection.
This API is used to post the message on channel.
\n","urlObject":{"path":["ent","v1","message"],"query":[],"variable":[]}},"response":[{"id":"e1aa2411-7793-416e-bc66-b7bf6547dd8b","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerThis API is used to fetch the messages on the channel window
\n","urlObject":{"path":["ent","v3","message"],"query":[{"description":{"content":"(Required) channelId to fetch the messages
\n","type":"text/plain"},"key":"channelId","value":"ullamco"},{"description":{"content":"(Required) indicate if history messages required
\n","type":"text/plain"},"key":"historyMessage","value":"true"},{"description":{"content":"(Required) reference post-id for history messages
\n","type":"text/plain"},"key":"postId","value":"ullamco"},{"description":{"content":"(Required) describes if this is a fresh request
\n","type":"text/plain"},"key":"isFresh","value":"ullamco"}],"variable":[]}},"response":[{"id":"1868d317-20bd-4f8e-be0c-c4177625349e","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerTest Post
\",\n \"type\": \"MESSAGE\",\n \"edited\": false,\n \"createdAt\": 1638269899173,\n \"updatedAt\": 1638269899173\n },\n \"user\": {\n \"id\": \"cedf4edd-a98b-4117-8bd9-2a67af60dcbf\",\n \"displayName\": \"Deepak\",\n \"userImg\": \"data:image/png;base64\"\n },\n \"fileInfo\": {\n \"fileDLStats\": {\n \"stats\": \"ad\"\n },\n \"previewAvailable\": false,\n \"fileForwardDisabled\": false\n },\n \"fileList\": [\n {\n \"fileId\": \"qX4JxAqvPJXgBESs3fTd3S\",\n \"userId\": \"cedf4edd-a98b-4117-8bd9-2a67af60dcbf\",\n \"postId\": \"90b8142c-834a-499c-9ad1-c4d169dacdc5\",\n \"postUUID\": \"90b8142c-834a-499c-9ad1-c4d169dacdc5\",\n \"channelId\": \"dc101b09-cbdb-494e-b4dd-4e312c94d6b4\",\n \"fileName\": \"post_sequencing.PNG\",\n \"mimeType\": \"image/png\",\n \"fileSize\": \"68.75KB\",\n \"thumbnailPath\": \"uploads/users/cedf4edd-a98b-4117-8bd9-2a67af60dcbf/5fde1703-9bcf-402b-a405-efdfdcb4321b/qX4JxAqvPJXgBESs3fTd3S/thumbnail\",\n \"status\": \"UPLOADED\",\n \"intPerm\": \"DL\",\n \"intPermOOO\": \"DL\",\n \"extPerm\": \"DL\",\n \"queryUserType\": \"INTERNAL\",\n \"createdAt\": 1638269897,\n \"updatedAt\": 1638269933,\n \"version\": 1,\n \"fileDLStats\": {\n \"stats\": [\n {\n \"type\": \"magna in\",\n \"total\": 1,\n \"users\": [\n {\n \"userId\": {\n \"value\": \"Test Post
\",\n \"type\": \"MESSAGE\",\n \"edited\": false,\n \"createdAt\": 1638269899173,\n \"updatedAt\": 1638269899173\n },\n \"user\": {\n \"id\": \"cedf4edd-a98b-4117-8bd9-2a67af60dcbf\",\n \"displayName\": \"Deepak\",\n \"userImg\": \"data:image/png;base64\"\n },\n \"fileInfo\": {\n \"fileDLStats\": {\n \"stats\": \"Lorem adipisicing amet veniam\"\n },\n \"previewAvailable\": true,\n \"fileForwardDisabled\": true\n },\n \"fileList\": [\n {\n \"fileId\": \"qX4JxAqvPJXgBESs3fTd3S\",\n \"userId\": \"cedf4edd-a98b-4117-8bd9-2a67af60dcbf\",\n \"postId\": \"90b8142c-834a-499c-9ad1-c4d169dacdc5\",\n \"postUUID\": \"90b8142c-834a-499c-9ad1-c4d169dacdc5\",\n \"channelId\": \"dc101b09-cbdb-494e-b4dd-4e312c94d6b4\",\n \"fileName\": \"post_sequencing.PNG\",\n \"mimeType\": \"image/png\",\n \"fileSize\": \"68.75KB\",\n \"thumbnailPath\": \"uploads/users/cedf4edd-a98b-4117-8bd9-2a67af60dcbf/5fde1703-9bcf-402b-a405-efdfdcb4321b/qX4JxAqvPJXgBESs3fTd3S/thumbnail\",\n \"status\": \"UPLOADED\",\n \"intPerm\": \"DL\",\n \"intPermOOO\": \"DL\",\n \"extPerm\": \"DL\",\n \"queryUserType\": \"INTERNAL\",\n \"createdAt\": 1638269897,\n \"updatedAt\": 1638269933,\n \"version\": 1,\n \"fileDLStats\": {\n \"stats\": [\n {\n \"type\": \"officia anim non\",\n \"total\": 1,\n \"users\": [\n {\n \"userId\": {\n \"value\": \"