HTTP methods and URL structure
When using the Document360 API, ensure that all requests are properly formatted in JSON and include the necessary headers. This section outlines the supported HTTP methods, required headers, URL structure, and authentication process.
Required headers
Every API request must include the following headers:
Header | Value |
---|---|
|
|
|
|
NOTE
All Document360 API requests must be made over HTTPS. Requests made over HTTP are not supported and will be rejected.
Supported HTTP methods
The Document360 API currently supports the following HTTP methods:
Method | Description |
---|---|
GET | Used for retrieving resources. |
POST | Used for creating resources. |
PUT | Used for replacing resources or collections. |
DELETE | Used for deleting resources. |
Each method must be used appropriately based on the action you want to perform. Incorrect method usage can result in errors such as 405 Method Not Allowed
.
API endpoints and URL structure
Document360 APIs follow a RESTful structure that uses consistent and predictable URL patterns. The base endpoint for all API calls is:
https://apihub.document360.io/v1/
This base path is followed by the type of resource you are interacting with. Resource names are always written in plural form.
Example: Retrieve a list of projects
https://apihub.document360.io/v1/projects
Example: Retrieve a specific article by ID
https://apihub.document360.io/v1/articles/eda6857b-8641-46fe-ac43-683996dc06a7
Example: Access a child resource (e.g., article settings)
https://apihub.document360.io/v1/articles/eda6857b-8641-46fe-ac43-683996dc06a7/settings
TIP
Always use the appropriate resource ID and confirm the hierarchy (parent → child) when working with nested resources.
Authentication
All API requests require an API token for authentication. You must include this token in the request headers.
Header key | Header value |
---|---|
|
|
To obtain your API token:
Go to your Document360 project dashboard.
Navigate to Settings () > Knowledge base portal > API tokens
Copy the token provided and use it in your request headers.
NOTE
Do not expose your API token in public repositories, client-side code, or unauthorized environments.