Authentication - dsimaging/dsio-filters-api GitHub Wiki

Authenticated requests for the IO Filters API follow the Basic authentication method. The Basic Auth method, which is among the most commonly implemented techniques for API authentication, includes a user name and a password. These items, separated by a colon and encoded as a base64 string, are supplied in the HTTP header when an authentication request is made.

Use of the IO Filters API requires an API key. The API key serves as the password and, with the user name, provides the necessary credentials to authorize requests using the API on the behalf of an approved application. Application developers who have been approved for use with this API will obtain their API key directly from Dentsply Sirona. Unique API keys should be used for distinct applications that consume the API.

Although they are familiar and practical, API keys should be protected like passwords and should not be shared publicly. The key uniquely identifies the application consuming the API and is intended to be used only for that purpose. The following are some general practices to keep in mind when developing applications using API keys:

1. Never share your API key publicly.
2. Do not embed your API key directly into source code.
3. Do not store your API key within the application source tree or commit it to version control.