Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

To access the API, required data are sent to a particular endpoint of the API. Each endpoint is labeled with a URI string (for example, something like “https://myedu.isoraisora.saltycloud.com/api/sheets”).

When sending or requesting data through the API, an HTTP “verb” is used to specify the nature of your request. While these keywords are not always standardized, ISORA’s Isora GRC’s API follows the principles of a “RESTful API” (Representational State Transfer API). Essentially, this means that each keyword has a specific purpose and a predictable result. Not all verbs will be accessible on all endpoints. Along with the verb, API calls may include information about resources stored in the server’s databases. These resources are representations of all the different objects ISORA Isora GRC knows about, like hosts, people, organizational units, sheets, etc.

...

GET

Request information about a resource without modifying anything

POST

Request that the server creates a new resource

PUT

Request the server to replace (update) a resource

DELETE

Request the server to remove a resource from ISORAfrom Isora GRC

Table 2.1.1 Common API calls

...

If working in a shell environment, built-in commands should allow you to access the API. For example, you could use the “Invoke-RestMethod” command in Windows PowerShell or “curl” in Linux or OS X.

ISORA Isora GRC uses authentication tokens to identify API users. This token, which is simply an ascii string, is included in the header of each HTTP message constructed when you make an API call. 

Next: 2.2 Enabling API access


Page Properties
hiddentrue


Related issues


...