API

API

Automate BlackNoise through its REST API


BlackNoise exposes a REST API so you can automate what you do in the web app, for example creating and running campaigns, qualifying event detection, and retrieving results, and integrate BlackNoise into your own tools and workflows. API access depends on your subscription.
For example, you can use the API to build custom dashboards: the data it returns feeds tailored visualization interfaces, which AI tools now make quick to create, so your teams read results exactly the way they want.


Create an API key

API keys are managed by users with the Administrator role, from Administration > API users, where you can create, edit, disable or delete tokens. Copy the full key when it is generated and store it securely — it is shown only once. See  API users .


Authenticate your requests

Requests are authenticated with your API key (the api-key value). The interactive documentation shows exactly where to provide it for each endpoint.


Access the API documentation

If your organization has API access, an API link appears at the bottom left of the screen, next to the documentation link. It opens the Swagger UI documentation in a new tab, listing every endpoint with, for each one:
  • the required and optional parameters;
  • response examples with the various HTTP codes and their meaning.
You can export this documentation as a JSON file (OpenAPI definition) to generate clients or import it into your API tooling.


Test an endpoint

You can test the API directly from the documentation:
    Select the endpoint you want to test.
    Click Try it out.
    Enter your API key.
    Click Execute.
    You get the executed curl command and the response obtained.
    


Retrieve or rotate your API key

The full API key is shown only once, at creation — it cannot be retrieved afterwards (clicking a token shows only the truncated value). If you lose it, an administrator must open the token and use Generate new key: the current key is revoked and a new one is issued. See  API users .