{"info":{"_postman_id":"7b79b30e-2b32-4953-9548-b4517592a95e","name":"Public API Compacto","description":"

Endpoints

POST /shortlink/public-generate
\n
POST /shortlink/public-generate-batch
\n

Welcome to the Compacto Public API documentation.
Here you will find all available public endpoints for creating short links.

Each endpoint includes required headers, body format, examples, and possible error messages.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"36638207","collectionId":"7b79b30e-2b32-4953-9548-b4517592a95e","publishedId":"2sB34bMjCq","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-07-04T16:25:59.000Z"},"item":[{"name":"Public-generate","id":"cf1b72b5-fe8a-4be5-b67c-b2a2cddef981","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{YOUR_API_KEY}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"La nueva carrera espacial se está calentando\",\r\n \"url\": \"https://www.xataka.com/espacio/nueva-carrera-espacial-se-esta-calentando-ahora-nasa-ha-vetado-a-ciudadanos-chinos-zoom\",\r\n \"domain\": \"cpt.cx\",\r\n \"tags\": [\"News\", \"BBC\"]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://cpt.cx/shortlink/public-generate","description":"

Description

This endpoint allows clients to create a public short link (shortened URL) by providing a minimal JSON payload. The endpoint requires an API Key and specific fields for successful processing.

Authentication

This endpoint requires an API Key to be included in the request headers:

x-api-key: YOUR_API_KEY\nContent-Type: application/json\n\n

Request Body (JSON)

Required fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`name`	string	A descriptive name for the short link.
`url`	string	The destination URL. Must be valid and use the `http` or `https` protocol.
`domain`	string	A registered domain associated with the client making the request.

Optional fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`tags`	array of strings	Optional tags associated with the short link. Example: `[\"News\", \"Tech\"]`.
`username`	string	Username for basic auth protection. Must be used together with `password`.
`password`	string	Password for basic auth. Must be used together with `username`.

Note: If username is provided, password must also be included — and vice versa.

Valid Request Example:

{\n  \"name\": \"BBC News\",\n  \"url\": \"https://www.bbc.com/news\",\n  \"domain\": \"cpt.cx\",\n  \"tags\": [\"News\", \"BBC\"]\n}\n\n

Successful Response

{\n  \"name\": \"BBC News\",\n  \"shortUrl\": \"https://cpt.cx/RRRRRF\",\n  \"createdDate\": \"2025-07-02T15:38:02.9554085Z\",\n  \"expiryDate\": \"2025-08-01T15:38:02.9554203Z\"\n}\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`name`	string	The name sent in the request.
`shortUrl`	string	The generated short link URL.
`createdDate`	datetime	Timestamp when the link was created.
`expiryDate`	datetime	Date when the short link will expire.

Invalid Cases and Error Messages

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

HTTP Code	Message	Reason
400	`\"Missing required fields: name, url, domain\"`	One or more required fields are missing.
400	`\"Invalid URL format.\"`	URL format is invalid (e.g., missing protocol).
400	`\"URL is not accessible.\"`	The target URL is unreachable or non-existent.
400	`\"Domain is not registered for this client.\"`	The domain is not associated with the client making the request.
400	`\"If a username is provided, a password must also be specified.\"`	Username is provided without a password.
400	`\"If a password is provided, a username must also be specified.\"`	Password is provided without a username.

Notes

Only http and https protocols are allowed in the url field. Others like ftp are rejected.
\n
If the specified domain is not associated with the client (based on the API Key), the request will be denied.
\n
ShortUrl is generated automatically using the configured domain.
\n
The default expiryDate is 30 days after createdDate.
\n

\n","urlObject":{"protocol":"https","path":["shortlink","public-generate"],"host":["cpt","cx"],"query":[],"variable":[]}},"response":[],"_postman_id":"cf1b72b5-fe8a-4be5-b67c-b2a2cddef981"},{"name":"Public-generate-batch","id":"d3cf7fd1-dbeb-483a-a18f-cb2cc3381964","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"{{YOUR_API_KEY}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\r\n {\r\n \"name\": \"BBC News\",\r\n \"url\": \"https://www.bbc.com/news\",\r\n \"domain\": \"cpt.cx\"\r\n },\r\n {\r\n \"name\": \"Facebook\",\r\n \"url\": \"https://www.facebook.com\",\r\n \"domain\": \"cpt.cx\",\r\n \"tags\": [\"News\", \"World\"]\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"https://cpt.cx/shortlink/public-generate-batch","description":"

Description

This endpoint allows clients to create a public short link (shortened URL) by providing a minimal JSON payload. The endpoint requires an API Key and specific fields for successful processing.

Authentication

This endpoint requires an API Key to be included in the request headers:

x-api-key: YOUR_API_KEY\nContent-Type: application/json\n\n

Request Body (JSON)

Required fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`name`	string	A descriptive name for the short link.
`url`	string	The destination URL. Must be valid and use the `http` or `https` protocol.
`domain`	string	A registered domain associated with the client making the request.

Optional fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`tags`	array of strings	Optional tags associated with the short link. Example: `[\"News\", \"Tech\"]`.
`username`	string	Username for basic auth protection. Must be used together with `password`.
`password`	string	Password for basic auth. Must be used together with `username`.

Note: If username is provided, password must also be included — and vice versa.

Valid Request Example:

[\n  {\n    \"name\": \"BBC News\",\n    \"url\": \"https://www.bbc.com/news\",\n    \"domain\": \"cpt.cx\"\n  },\n  {\n    \"name\": \"Facebook\",\n    \"url\": \"https://www.facebook.com\",\n    \"domain\": \"cpt.cx\",\n    \"tags\": [\"News\", \"World\"]\n  }\n]\n\n

Successful Response

{\n    \"summary\": {\n        \"successCount\": 2,\n        \"failedCount\": 0\n    },\n    \"results\": [\n        {\n            \"name\": \"BBC News\",\n            \"shortUrl\": \"https://cpt.cx/RRRRRT\",\n            \"createdDate\": \"2025-07-02T15:42:05.2432041Z\",\n            \"expiryDate\": \"2025-08-01T15:42:05.2432043Z\"\n        },\n        {\n            \"name\": \"Facebook\",\n            \"shortUrl\": \"https://cpt.cx/RRRRRa\",\n            \"createdDate\": \"2025-07-02T15:42:05.4787264Z\",\n            \"expiryDate\": \"2025-08-01T15:42:05.4787265Z\"\n        }\n    ]\n}\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`name`	string	The name sent in the request.
`shortUrl`	string	The generated short link URL.
`createdDate`	datetime	Timestamp when the link was created.
`expiryDate`	datetime	Date when the short link will expire.

Response Breakdown

StartFragmentsummary.successCount — Number of successfully created short links.EndFragment
\n
StartFragmentsummary.failedCount — Number of short links that failed validation.EndFragment
\n
StartFragmentresults[] — List of successfully created short links (one per valid input item).EndFragment
\n

Invalid Cases and Error Messages

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

HTTP Code	Message	Reason
400	`\"Missing required fields: name, url, domain\"`	One or more required fields are missing.
400	`\"Invalid URL format.\"`	URL format is invalid (e.g., missing protocol).
400	`\"URL is not accessible.\"`	The target URL is unreachable or non-existent.
400	`\"Domain is not registered for this client.\"`	The domain is not associated with the client making the request.
400	`\"If a username is provided, a password must also be specified.\"`	Username is provided without a password.
400	`\"If a password is provided, a username must also be specified.\"`	Password is provided without a username.

Notes

Only http and https protocols are allowed in the url field. Others like ftp are rejected.
\n
If the specified domain is not associated with the client (based on the API Key), the request will be denied.
\n
ShortUrl is generated automatically using the configured domain.
\n
The default expiryDate is 30 days after createdDate.
\n

\n","urlObject":{"protocol":"https","path":["shortlink","public-generate-batch"],"host":["cpt","cx"],"query":[],"variable":[]}},"response":[],"_postman_id":"d3cf7fd1-dbeb-483a-a18f-cb2cc3381964"}]}