Interactive API documentation

Clearance Developer Guide

Content type
Guides > Developer guides
Product line
Clearance
Language
English
Applies to
Genetec Clearance

To access Genetec Clearance™'s APIs, test them, and interact with them without having to develop code, you can use your valid Clearance account to run the Swagger UI and call the API directly from the Web.

Clearance APIs are built using Swagger, a framework to build APIs that lets developers use OpenAPI Specification (OAS) to document and share Web API. It provides many tools to simplify API usage and management.

  1. Verify your Clearance account.

    You must have a valid Clearance account. Normally, your developer account should have been provisioned on the regular North American datacenter. The URL to access your account should be https://www.clearance.network.

  2. Open the interactive documentation for the Search Service located at https://dems-proda-api.clearance.network/searchservice/api/v1/swagger/.

    This opens the Swagger UI.

  3. Authenticate yourself using OpenID and click Authorize.


    Image
  4. Call any method of the API directly from the Web interface.

The TenantId is required for any API call and can be found in the JSON Connection File.