Versions Compared

Key

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

...

Each of the API documentation pages contain information covering the scope and purpose of each interface. Additionally, there is an embedded Swagger UI client on the page with the purpose of allowing customers a simple interactive way to try out certain functions and learn how the API can be used. This video provides a quick demonstration on how to use the embedded functions.

...

We expect encourage customers to first try and learn about API invocations with the Swagger UI client on this documentation site. Once you have successfully invoked the API with this client, you will find that it provides client bindings and command line invocation patterns that will work directly for integrations or other API clients/tooling.

...

ClinSpark supports Basic HTTP (basic auth) and Bearer HTTP (token) authentication schemes.

Bearer HTTP tokens were introduced in version 23.3. Both auth schemes can be applied and used on API accounts.

Info

As customers upgrade to more recent versions of ClinSpark, they are encouraged to explore using API tokens and adopt use for API accounts accordingly. Support for Basic Authentication may be deprecated in a future release of ClinSpark, to be replaced with authentication schemes that meet stronger security standards and modern best practices.

...