Getting Started with API

This section provides an overview of how to get started with the Deeply API.

BannerDeeply API Documentation
Deeply API Documentation

Deeply provides an environment where you can interact with the central server through API integrations.

The Deeply API is structured in a RESTful format with resource-oriented URLs, returns JSON responses, and utilizes standard HTTP response codes and authentication. While most endpoints follow REST principles, some services are also available through WebSocket connections when real-time communication or streaming data is required.

Base URLs

The base URL used for the Deeply API is formatted as shown below.

https://openapi.deeplyinc.com

Requirements

The Deeply API requires:

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

For firewall and proxy configurations:

  • 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.

Headers

Requests to the Deeply API should include the following headers:

  • Content-Type: application/json; charset=utf-8
  • Authorization: Bearer DEEPLY-API-TOKEN

By default, all requests require the Content-Type header.

The authorization token can be sent using the Authorization header.

Authentication

Deeply API uses an API Key for authentication. You can view and manage your API keys by contacting us.

Rate Limit

All APIs have it's own limit. Refer to rate limit page for detailed information.

Postman Collection

Run In Postman

Postman is an API client that simplifies API usage. To facilitate integration with Deeply, a Postman Collection is provided.

Using the Postman Collection

To use the Postman Collection, fork the collection and populate the value for api_key. Copy your API token and paste them into the initial value.