Skip to content
ClicknClear Docs

Overview

API Docs 1.0.0

Section titled “API Docs 1.0.0”

Servers and Resources

API Keys

To create an API key please make sure you first contact a ClicknClear admin so they can enable API Key support for your user account.

API Key Setup

  • Navigate to https://music.clicknclear.com/profile (login if you are not).
  • If your account is setup correctly you should have an “API Keys” section. If you cannot see this section please get in contact via the support email or the Tech Team email.
  • Click the “Create API Key” button.
  • Enter a name for the API Key, this is to help you identify it at a later date.
  • Copy the API Key ID and the API Key Secret and store them somewhere safe, you will not be able to view the Key Secret again.
  • To use the postman collection, copy the API Key ID and the API Key Secret into the relevant postman environment variables.

Authentication

See the Login routes for more information on how to get Access Tokens and Refresh Tokens. There is a Postman script on the Login route that will automatically add the access and refresh tokens to your postman environment. To authenticate your requests to the ClicknClear API add the access token to the “Authorization” header with the value of “Bearer {ACCESS_TOKEN}”.

Example:

'Authorization': 'Bearer XXXXX'

Server Responses

Return Types

Most endpoints will have example responses, however they may not always be 100% up to date. To find up to date, annotated typescript types you can directly use or view on Github, please see: https://github.com/ClicknClear/Public-Resources/tree/main/packages/lvs-types

Return Codes

Throughout our APIs we heavily utilise HTTP Codes to signify the status of the request. In general, a 4xx status code will have the error type and usually a message to help the developer know why the request failed. Below is an example of an erroneous login request.

{
    "statusCode": 400,
    "error": "Bad Request",
    "message": "[\n  {\n    \"code\": \"invalid_type\",\n    \"expected\": \"string\",\n    \"received\": \"undefined\",\n    \"path\": [\n      \"apiKey\"\n    ],\n    \"message\": \"Required\"\n  }\n]"
}

If you are consistently receiving 400s or even 500s and you’re not sure how to fix it please email the Tech Team email with steps to reproduce your issue.

Information

  • OpenAPI version: 3.0.0

Operations

Section titled “ Operations ”
POST
/api/auth/api-key/login
POST
/api/auth/access-token/refresh
GET
/api/orgs/me
GET
/api/public/v1/season
POST
/api/public/v1/season/{seasonId}/entries
POST
/api/public/v1/verification-job
GET
/api/public/v1/verification-job/{verificationJobId}
POST
/api/public/v1/verification-job/search
POST
/api/public/v1/event/{id}/entries
POST
/api/public/v1/event

Authentication

Section titled “ Authentication ”

BearerAuth

Section titled “BearerAuth ”

Security scheme type: http