Introduction

Introduction to the Node Social API documentation

Welcome to the Node Social API documentation. This guide provides developers with all the information needed to interact with the API.

API Version: 1.1 "Vega"

Base URL: https://api.nodesocial.org/

All API endpoints are relative to this base URL. Throughout this documentation, the base URL will be referred to as {base}.

Versioning

The Node Social API follows a major.minor.patch-hotfix versioning scheme (e.g., 1.6.3-9).

This documentation is manually updated for each minor release. For the most up-to-date details, including patch and hotfix changes, please refer to our auto-generated OpenAPI specification, which is always available at api.nodesocial.org/swagger/index.html.

Requests & Headers

The API exclusively uses JSON for requests and responses. All requests must include the Content-Type: application/json header.

Header

"Content-Type": "application/json"

Every field that has, for example, "string", it means the data type you're supposed to use.

Authentication

Endpoints marked with an asterisk (*) require authentication. These requests must include an Authorization header containing a bearer token.

Header

"Authorization": "Bearer ${token}"

A complete header for an authenticated request requiring a JSON body would look like this:

Header

{
    "Content-Type": "application/json",
    "Authorization": "Bearer ${token}"
}