Getting Started with API - v2025.08 - Deeply API Documentation

Archived Version: v2025.08

You are viewing an archived reference version.

Deeply API Documentation

Version notice: The API key flow below applies to v2025.08. Starting with v2026.02, send API account credentials (username and password) in a JSON body to POST /api/v1/auth/token to issue an access token and a refresh token yourself. Use the access token for normal API requests and the refresh token for GET /api/v1/auth/reissue. See the v2026.02 Quick Start and Issue Token.

Deeply API provides REST endpoints for central server integration and WebSocket interfaces for real-time events. If you are new here, complete these three steps first.

1. Prepare Your API Key

API Key: long-lived credential used only to issue an access token
Access Token: Bearer token used for normal API requests

If your key has not been issued yet, contact contact@deeplyinc.com.

2. Issue An Access Token

Use the API Key to issue an access token, then use the access token for normal API calls.

3. Send Your First Request

After token issuance, List Events is the fastest endpoint to validate your integration.

Base URL

All REST API requests use the following local base URL by default.

http://{{EDGE_IP}}:8100

If you want to validate the public HTTPS environment, you can also test with https://openapi.deeplyinc.com.

Public HTTPS Test Requirements

The items below apply when you test against https://openapi.deeplyinc.com:

HTTPS connection with TLS 1.2 or higher
Standard port 443
DNS cache TTL of 300 seconds
API Key

For firewall and proxy configurations for https://openapi.deeplyinc.com:

Allow outbound HTTPS traffic on port 443
Whitelist https://openapi.deeplyinc.com or allow all public IP addresses

Note: Properly configured DNS cache helps prevent requests to stale IP addresses.

Request Headers

For normal API requests, include:

Content-Type: application/json; charset=utf-8
Authorization: Bearer YOUR_ACCESS_TOKEN

For access-token issuance, use Authorization: Bearer YOUR_API_KEY.

Start Quickly With Postman

Postman is an API client that simplifies API usage. To facilitate integration with Deeply, a Postman Collection is provided. Fork the collection and fill the api_key environment variable with your issued API key to test the main requests immediately.

Authorization

1. Prepare Your API Key 2. Issue An Access Token 3. Send Your First Request Base URL Public HTTPS Test Requirements Request Headers Read Next Start Quickly With Postman

const response = await fetch('http://{{EDGE_IP}}:8100/api/v1/auth/reissue', {
  method: 'GET',
  headers: {
    "Authorization": "Bearer YOUR_API_KEY"
  }
});

const data = await response.json();

const response = await fetch('http://{{EDGE_IP}}:8100/api/v1/events?page=1&size=10', {
  method: 'GET',
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN"
  }
});

const data = await response.json();

1. Prepare Your API Key#

2. Issue An Access Token#

3. Send Your First Request#

Base URL#

Public HTTPS Test Requirements#

Request Headers#

Read Next#

Start Quickly With Postman#