Introduction

This documentation aims to provide all the information you need to work with our API.

Mail test server: http://backend-aggregation.subsig.com:8025 (HTTP only)

Postman collection: http://backend-aggregation.subsig.com/docs.postman

OpenAPI spec: http://backend-aggregation.subsig.com/docs.openapi

Authenticating requests

To authenticate requests, include an Authorization header with the value "Bearer 1|abc123...".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

You can retrieve your token by visiting your dashboard and clicking Generate API token.

Endpoints

Handle incoming Subsig Reviews webhook (POST with X-Scraper-Signature).

Validates signature in middleware; validates payload; queues processing and returns 202 Accepted.

const url = new URL(
    "http://backend-aggregation.subsig.com/api/v1/webhooks/scrape-finished"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Handle incoming Subsig Social webhook (POST with X-Scraper-Signature).

Validates signature in middleware; validates payload; queues processing and returns 202 Accepted. Does not write to social_posts; only updates aggregation tables and records deliveries (in job).

const url = new URL(
    "http://backend-aggregation.subsig.com/api/v1/webhooks/social-scrape-finished"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.