Getting Started (1.0.0)

Cincopa REST API V2 to get/set and manipulate assets and galleries

Cincopa REST API V2 is a simple set of REST based methods that allow you to access almost every aspect of your galleries and assets. Authentication is done with a simple api_token that can be created and deleted per app, set the permission level according to the needed level and exposure level.

V2 API was designed to be used:

in server-to-server scenario where the api_token and information is not exposed to the public, in such scenario the permissions level can allow write and delete.
in client-to-server scenario like javascript request from a public web page, in this scenario permission level will be set to read only which ensures the safety of your web app. This unique architecture eliminates the need of creating a "proxy" service that usually needed when working with a 3rd party API thus saving you time in integration.

Download OpenAPI description

index.json

index.yaml

Overview

Cincopa API Support support@cincopa.com

License MIT

Servers

Cincopa API

https://api.cincopa.com/v2/

General

This section offers foundational API endpoints essential for establishing and validating connections with the Cincopa platform. These endpoints are designed to ensure smooth integration and secure interactions between your application and Cincopa's services.

Key Functionalities	Endpoint	Purpose
Validate API Connection	`/ping.json`	This endpoint allows you to confirm the validity and responsiveness of your API connection. By sending a request to /ping.json with your `api_token`, you can verify that your application is properly authenticated and can communicate effectively with Cincopa's servers.
Obtain a Temporary Token	`/token.get_temp.json`	In scenarios where frontend applications require direct interaction with Cincopa's API, this endpoint provides a secure method to generate temporary tokens. These tokens facilitate client-to-server communications, enabling operations like updating galleries or assets directly from client-side code without exposing permanent credentials.

Operations

Gallery

This section provides a comprehensive suite of methods for managing your media galleries. The Gallery API empowers developers to programmatically create, manage, and customize multimedia galleries for seamless integration into applications, websites, or digital platforms.

Whether you're building a media-rich portal, a dynamic content hub, or a branded video experience, this API provides granular control over gallery configurations, media assets, permissions, and display logic.

Key Functionalities	Endpoint	Purpose
Creating Galleries	`/gallery.create.json`	Establish new media galleries to organize your content effectively.
Setting Gallery Metadata	`/gallery.set_meta.json`	Update gallery information such as title, description, and custom properties to keep your content organized and accessible.
Deleting Galleries	`/gallery.delete.json`	Remove galleries that are no longer needed, ensuring your media library stays current.
Adding Items to Galleries	`/gallery.add_item.json`	Incorporate new media assets into existing galleries to enhance your content offerings.
Removing Items from Galleries	`/gallery.remove_item.json`	Manage your galleries by removing outdated or unwanted media assets.
Listing Galleries	`/gallery.list.json`	Retrieve a list of all galleries in your account for easy management and overview.
Retrieving Gallery Items	`/gallery.get_items.json`	Access detailed information about the media assets contained within a specific gallery.
Setting Master Media	`/gallery.set_master.json`	Designate a primary media asset within a gallery to highlight featured content.

Operations

Assets

This section provides a comprehensive suite of methods for managing assets within your account. The Assets API enables developers to efficiently upload, organize, modify, and retrieve digital assets, ensuring seamless integration into applications, websites, or media platforms.

Whether you're handling large media libraries, automating asset management, or implementing structured metadata, this API offers precise control over asset creation, metadata customization, categorization, and retrieval, enhancing workflow efficiency and content organization.

Key Functionalities	Endpoint	Purpose
List Assets	`/asset.list.json`	Get a list of assets in the account; those assets can be added to any gallery. Use search to locate specific assets or use reference_id to locate by reference_id of the asset.
List Tags	`/asset.get_tags.json`	Fetches all tags associated with assets for categorization and filtering. Returns a structured list for efficient metadata management.
Set meta data of an asset	`/asset.set_meta.json`	Updates or adds metadata (title, description, custom fields) for a specific asset. Requires the asset ID and enhances searchability and organization.
Resync an asset	`/asset.resync.json`	Resync an asset will start a process of checking for missing versions and generating them. This method is only needed in cases of a failure to sync a gallery.
Delete an asset	`/asset.delete.json`	Delete an asset for good, it will be removed also from any gallery that exists.
Get upload URL to POST an asset.	`/asset.get_upload_url.json`	Get upload URL to your assets library, use this URL with an HTTP POST method. Asset can be added directly to a gallery or be attached to another asset to set the video poster, for example. When attaching to another asset, it must provide a type name.
Start uploading an asset from an input URL.	`/asset.upload_from_url.json`	Upload an asset from an input URL. Asset can be added directly to a gallery or be attached to another asset to set the video poster, for example. When attaching to another asset, must provide a type name. This method will return a status ID that can be used by asset.upload_from_url_get_status to get information about the upload process and the ID of the uploaded asset when done.
Get status during and after the uploading process.	`/asset.upload_from_url_get_status.json`	Use this method to get the Id of the uploaded asset when done.
Abort uploading process.	`/asset.upload_from_url_abort.json`	Use this method to abort an upload.

Operations

Upload

This section provides you with a detailed overview of Cincopa's Upload API, which allows users to upload media files to their Cincopa galleries efficiently. The API offers two primary methods for uploading content: an embeddable iFrame for direct user uploads and a secure token-based system for controlled access. These options ensure flexibility, security, and ease of use, making it simple to integrate media uploads into your applications or websites.

With the embeddable iFrame, users can upload media directly through an interactive interface that supports drag-and-drop functionality, media selection, and content management features like metadata editing and file reordering. On the other hand, the token-based system ensures that only authorized users can upload media by generating a secure upload token.

Key Functionalities	Endpoint	Purpose
HTML iframe to manage gallery	`/upload.iframe`	Provides an embeddable iFrame URL for users to upload media directly to a Cincopa gallery. The interface supports drag-and-drop uploads, media selection, metadata editing, reordering, and deletion. It is fully responsive across devices.
Invite upload token	`/upload.get_upload_token.json`	Generates a unique token that restricts access to the invite upload page, ensuring that only authorized users can upload media to a specified gallery.

Operations

Portal

This section provides a comprehensive suite of methods for managing and customizing portals. The Portal API allows developers to programmatically create, manage, and configure landing pages, video hubs, and share pages for seamless integration into applications, websites, or digital platforms.

Whether you're building a dynamic content hub, a multimedia-rich portal, or a branded video experience, this API offers full control over portal settings, status management, and retrieval of existing portals. The following table provides a breakdown of the available API endpoints and their functions:

Key Functionalities	Endpoint	Purpose
Verify subdomain	`/portal.check.json`	Checks if a portal exists and retrieves its status. This is useful for validating whether a portal is active before performing further operations.
Create subdomain if available	`/portal.cease.json`	Deactivates or ceases an existing portal. This operation is useful when a portal is no longer needed but should not be permanently deleted.
Rename subdomain	`/portal.rename.json`	Renames a specified portal by providing the existing portal ID and the new desired name. This helps in organizing portals efficiently.
Remove subdomain	`/portal.remove.json`	Deletes a portal from the system. This operation is irreversible and permanently removes all associated data.
Save subdomain	`/portal.set.json`	Creates a new portal or updates the settings of an existing one. This allows customization of portal properties such as name, visibility, and other configurations.
List of portals	`/portal.list.json`	Retrieves a list of all configured portals along with their details. This endpoint helps in managing multiple portals and tracking their statuses.

Operations

Webhook

This section provides a streamlined way to receive real-time notifications about account activities via HTTP POST callbacks. Instead of continuously polling for updates, webhooks allow external applications to listen for specific events and respond accordingly.

This API enables developers to automate workflows, synchronize data, and receive alerts whenever significant actions occur in the system. Additionally, the API supports Slack integration, allowing event notifications to be delivered directly to a Slack channel for easy monitoring and collaboration.

Key Functionalities	Endpoint	Purpose
List of webhooks	`/webhook.list.json`	Retrieves a list of all active webhooks associated with the account, including their configurations and callback URLs.
Create/update webhook	`/webhook.set.json`	Registers a new webhook by specifying a callback URL and event types to trigger notifications.
Create/update webhook to slack	`/webhook.set_slack.json`	Sets up a webhook that sends real-time event notifications directly to a Slack channel for instant updates.
Delete a webhook	`/webhhook.delete.json`	Deletes an existing webhook, stopping further event notifications and removing it from the system.

Operations

List of webhooks

Request

This API allows users to retrieve all active webhooks associated with their account. This endpoint provides an overview of registered webhooks, including their callback URLs and event types. It enables seamless management of webhook configurations, ensuring users can monitor or update their event-driven integrations efficiently.

Endpoint: GET /webhook.list.json

URL: https://api.cincopa.com/v2/webhook.list.json

Query

api_tokenstringrequired

A unique key used for authentication. Must be a valid API key provided by the system. Without the valid api_token, the request will be rejected with a 403 Unauthorized error.

Example: api_token=AAAAtAURG

curl -i -X GET \
  'https://api.cincopa.com/v2/webhook.list.json?api_token=AAAAtAURG'

Responses

When the request for retrieving the list of webhooks is successfully processed, the API returns a 200 OK response containing key details about the operation.

Bodyapplication/json

successboolean

Indicates whether the request was successful. true for success, false for failure. Always true for a 200 response

Example: true

runtimeinteger

Specifies the total time taken to process the request, measured in milliseconds.

Example: 77

webhooksArray of arrays

A collection of webhook objects, where each object contains details of a registered webhook.

Response

application/json

{
  "success": true,
  "runtime": 77,
  "webhooks": []
}

Create/update webhook

Request

This API endpoint allows users to create or modify a webhook by specifying a target URL (hook_url). A webhook is a mechanism that enables real-time notifications when specific events occur in the system. When a webhook is created or updated, it listens for particular events and triggers an HTTP request to the specified hook_url.

Endpoint: POST /webhook.set.json

URL: https://api.cincopa.com/v2/webhook.set.json

Query

api_tokenstringrequired

A unique key used for authentication. Must be a valid API key provided by the system. Without the valid api_token, the request will be rejected with a 403 Unauthorized error.

Example: api_token=AAAAtAURG

hook_urlstringrequired

The URL that will receive event notifications when the webhook is triggered. This URL should be properly configured to handle incoming webhook requests.

Example: hook_url=test87

security_keystringrequired

A secret key used to hash the URL and append it when calling the hook_url. This adds an extra layer of security, ensuring that only authorized requests are processed.

Example: security_key=4dfdfdc39

eventsstring

Specifies the events that will trigger the webhook. Users can define one or multiple namespace events. Available namespaces include gallery., asset., account., analytics., leads.* (with * indicating all events under a namespace).

Example: events=asset

curl -i -X POST \
  'https://api.cincopa.com/v2/webhook.set.json?api_token=AAAAtAURG&events=asset&hook_url=test87&security_key=4dfdfdc39'

Responses

When a request is successfully processed the endpoint, the API returns a 200 OK status code. This indicates that the webhook has been successfully created or updated. The response body is returned in JSON format and contains the following fields

Bodyapplication/json

successboolean

A flag indicating the success of the request. True means the request was processed successfully, while false indicates failure

Example: true

runtimeinteger

The total time (milliseconds) taken by the server to process the request and return a response.

Example: 44

Response

application/json

{
  "success": true,
  "runtime": 44
}

Create/update webhook to slack

Request

This API endpoint allows users to create or update a webhook that sends messages to a specified Slack channel. This webhook integration enables automated notifications based on specified events, improving communication and workflow efficiency. Users must provide authentication credentials, specify the Slack webhook URL, and define parameters such as the Slack channel, username, and optional icon.

Endpoint: POST/webhook.set_slack.json

URL: https://api.cincopa.com/v2/webhook.set_slack.json

Query

api_tokenstringrequired

A unique key used for authentication. Must be a valid API key provided by the system. Without the valid api_token, the request will be rejected with a 403 Unauthorized error.

Example: api_token=AAAAtAURG

hook_urlstringrequired

The Slack webhook URL where messages will be sent. This must be in a valid Slack webhook format.

Example: hook_url=https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX

eventsstring

Defines the events that will trigger the webhook call. The specified events determine when messages are sent to Slack.

Default "*(all)"

Example: events=asset

slack_channelstringrequired

The Slack channel where the messages will be posted. This should be in the format of a channel name or workspace channel.

Example: slack_channel=cincopatest.slack.com

slack_usernamestring

The username that will appear as the sender of the message. Defaults to the integration’s configured username if not provided.

Default "cincopa_bot"

Example: slack_username=test

slack_iconstring

An optional icon for the message sender. This can be an emoji (e.g., :smile:) or a URL linking to an image.

Example: slack_icon=:)

curl -i -X POST \
  'https://api.cincopa.com/v2/webhook.set_slack.json?api_token=AAAAtAURG&events=asset&hook_url=https%3A%2F%2Fhooks.slack.com%2Fservices%2FT00000000%2FB00000000%2FXXXXXXXXXXXXXXXXXXXXXXXX&slack_channel=cincopatest.slack.com&slack_icon=%3A)&slack_username=test'

Responses

When the request to create or update a Slack webhook is successfully processed, the API returns a 200 OK response. This response confirms that the webhook has been set up or modified correctly and is now ready to send messages to the specified Slack channel. Below are the response parameters with their descriptions and examples.

Bodyapplication/json

successboolean

A flag indicating the success of the request. True means the request was processed successfully, while false indicates failure

Example: true

runtimeinteger

The total time (milliseconds) taken by the server to process the request and return a response.

Example: 44

Response

application/json

{
  "success": true,
  "runtime": 44
}

Delete a webhook

Request

This API endpoint allows users to remove an existing webhook from the system. By making a request to this endpoint with the necessary authentication and webhook details, users can ensure that the specified webhook URL is no longer active or receiving event notifications.

Endpoint:POST/webhook.delete.json

URL: https://api.cincopa.com/v2/webhook.delete.json

Query

api_tokenstringrequired

A unique key used for authentication. Must be a valid API key provided by the system. Without the valid api_token, the request will be rejected with a 403 Unauthorized error.

Example: api_token=AAAAtAURG

hook_urlstringrequired

The URL of the webhook to delete. It must be a valid Slack webhook format and should match an existing webhook entry.

Example: hook_url=cincopatest

curl -i -X POST \
  'https://api.cincopa.com/v2/webhook.delete.json?api_token=AAAAtAURG&hook_url=cincopatest'

Responses

When the webhook is successfully deleted, the API returns a 200 OK response. This response confirms that the specified webhook has been removed from the system. Below are the response parameters with their descriptions and examples.

Bodyapplication/json

successboolean

A flag indicating the success of the request. True means the request was processed successfully, while false indicates failure

Example: true

runtimeinteger

The total time (milliseconds) taken by the server to process the request and return a response.

Example: 44

Response

application/json

{
  "success": true,
  "runtime": 44
}

Live

Professional Live Video Streaming Service.

Operations

Getting Started (1.0.0)

Cincopa REST API V2 to get/set and manipulate assets and galleries

General

Gallery

Assets

Upload

Portal

Webhook

List of webhooks

Request

Responses

Was this helpful?

Create/update webhook

Request

Responses

Was this helpful?

Create/update webhook to slack

Request

Responses

Was this helpful?

Delete a webhook

Request

Responses

Was this helpful?

Live