Realise the Full Potential of Our Public API

 

If you have purchased ISMS.onlines integration bundle, you'll receive access to the public API. The API can be used to connect another system to ISMS.online, either by using in-house development or by leveraging an integration platform to join the two systems together. 


The API allows you to connect a system of your choice to any Track in ISMS.online, use cases include:

  • Raise security incidents in ISMS.online to centralise incident monitoring and resolution.
  • Send new threats and vulnerabilities into the Threat Intelligence track from various threat awareness tools, allowing you to monitor new threats, and remediate known threats in one place.
  • Automatically add new assets to the asset inventory from another asset management system.


The API can interact with these fields in Tracks, we will be releasing additional endpoints over time to support popular use cases:

  • Creating Track items:
    • Name
    • Description
    • Due date
    • Assign a category
    • Assign a user

 


Developer Documentation

Dive into the ISMS.online Public API with intuitive, step-by-step documentation. Our comprehensive guide empowers developers of all levels to unlock the full potential of our API. Get started quickly with clear instructions, code examples, and helpful resources: http://ismsonline.stoplight.io



How can I purchase the integrations package?


Our integrations package not only includes our new Public API feature. You will also be able to integrate Google Docs, OneDrive, and Zapier within your platform. If you require more information regarding the purchase of our integrations package, you can find this on marketplace which we have linked for you here. You can also contact your Customer Support Manager, or email our support team at support@isms.online.



How can I allow users to generate API Keys?


Any user on the platform can be given permission to generate API keys by a platform administrator. If you are a platform administrator you can grant this permission using the following steps:


1. From the menu on the top right hand corner, select "organisation settings"


2. Select the 'Users' tab


3. Select the user you would like to grant the permission to, and then select the "User Settings" tab


4. Under "API Keys" select the checkbox to allow the user to generate API keys, and then press save




How to Generate a New API Key


1. From your own user preferences page, in the area above where the API has been enabled you should be able to see a "Generate new API Key:


2. Select the "Generate new API Key" where you should see the following where you can select a label and an expiry period for the API Key:


3. Once completed, you will be shown the API key ready to copy. Make sure to copy this key as it will not be visible again. This key can only be viewed and copied once for security purposes: 


Important things to note:


- You need a new API key for each application

- You can only use an API key for applications you have access to within the platform. For example, if you only have access to the Asset Inventory Track, any API Key you generate will only allow items to be created within the Asset Inventory track.

- Users are able to revoke Keys when required, only an organisation administrator can revoke other users API Keys.

- Revoking an API Keys/ users permission to generate API Keys will cause any API's under those Keys to stop working.