# System API

System APIs provide access to data from an organization's core systems of record. The System API page features Swagger-UI, which generates interactive documentation from an existing JSON or YAML document.

System API View

Name Description
Authorize Click this button to authorize yourself to gain access to Swagger.
Swagger Management Select a method name to expand the section.

# Authorize

Bearer Authentication (token authentication) is an HTTP authentication scheme involving security tokens called bearer tokens. The name "bearer authentication" can be understood as "giving access to the bearer of this token." The token is a cryptic string usually generated by the server in response to a login request. The client must send this token in the Authorization header when requesting protected resources.

System API Authorize View

Name Description
Value Paste the API token from the API Tokens. section.
Authorize Click Authorize to confirm the action.

# Swagger Management

Any action method in controllers can be tested from the user interface.

  • Select a method name to expand the section.
  • The executed response will be listed at the bottom.

System API Parameters View

Name Description
Try it out Enables the input fields required for testing.
Fields Enter the required parameters, which may vary.
Execute Runs the test and displays the HTTP response.