API Documentation

This is the documentation for the available API endpoints, which are built around the REST architecture. All the API endpoints will return a JSON response with the standard HTTP response codes and need a Bearer Authentication via an API Key.

api_documentation.api_key_retrieve

Base URL

Authentication

All the API endpoints require an API key sent by the Bearer Authentication method.

Authorization: Bearer {api_key}

Example

curl --request GET \
--url 'https://premier.dcardtech.com/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \

api_documentation.errors.header

api_documentation.errors.subheader

Example

{
    "errors": [
        {
            "title": "You do not have access to the API.",
            "status": 401
        }
    ]
}

api_documentation.status_codes

200 api_documentation.status_codes.200

400 api_documentation.status_codes.400

401 api_documentation.status_codes.401

404 api_documentation.status_codes.404

429 api_documentation.status_codes.429

500 api_documentation.status_codes.500

All API endpoint results work with the UTC timezone unless specified otherwise.

User

Links

Links statistics

Projects

Pixels

Splash pages

QR codes

Data

Notification handlers

Custom domains

Account payments

Account logs