Short.io

Short.io is a URL shortening and branded link management platform with built-in click analytics. It lets you create and manage short links on your own custom domains, organize them, and track click performance. Nexla connects to the Short.io REST API so you can ingest domains, links, permissions, and statistics as a data source, and create or manage links, domains, and QR codes as a destination.

Power end-to-end data operations for your Short.io API with Nexla. Our bi-directional Short.io connector is purpose-built for Short.io, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Short.io or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Short.io workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

• Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
• Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
• API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
• Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Short.io authenticates every API request with an API key sent in the Authorization header. Before creating a Short.io credential in Nexla, generate an API key from your Short.io account.

1. Sign in to your Short.io account.

2. Open the Integrations & API page from your account settings.

3. In the API section, click Create API key.

4. Choose the access level for the key — all domains, restricted to a team, or restricted to a specific domain — based on the resources this integration needs to reach.

5. Copy the generated secret key and store it securely. Short.io displays the secret only once at creation time and it cannot be retrieved later. If you lose it, create a new key.

Treat the API key as a secret. Only the owner of the key is responsible for actions taken with it, so avoid sharing it. For more detail, see the Short.io API reference and the Short.io API documentation.

Authenticate

Credentials required

Field	Required	Secret	Description
API Key Value	Yes	Yes	An encoded string value used as a secret token to authenticate API requests

Create a credential in Nexla

1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

3. Enter your Short.io API key in the API Key Value field. This is the secret key you generated in Prerequisites; Nexla sends it in the Authorization header on every request to the Short.io API and keeps it confidential.

   If your API key is compromised, create a new key in the Integrations & API section of your Short.io account and update this credential. Because the secret is shown only once at creation, keep a secure copy when you generate it.

4. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Short.io connector tile, then select the credential that will be used to connect to Short.io, and click Next; or, create a new Short.io credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Short.io endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

[Rest API] List domains

Retrieves a list of the domains in your Short.io account.

• Use this endpoint to enumerate the domains available under your API key, including the domain IDs needed to configure other Short.io endpoints.

[Rest API] Get domain details by id

Retrieves the details of a single domain identified by its domain ID.

• Provide the domain ID as the path parameter for the endpoint to fetch that domain's configuration and metadata.

[Rest API] List links

Retrieves a list of short links for a domain.

• Specify the domain ID to scope the results, and use the limit and offset parameters to page through large sets of links.

[Rest API] Create new link (simple version)

Creates a new short link using the simple endpoint and returns the created link.

• Supply the destination domain and the original URL as parameters; the endpoint shortens the URL and returns the resulting short link.

[Rest API] Get link info by id

Retrieves the details of a single short link identified by its link ID.

• Provide the link ID as the path parameter to fetch that link's destination, path, and metadata.

[Rest API] Get link info by original URL

Retrieves the short link that matches a given original (destination) URL within a domain.

• Provide the domain ID and the original URL to look up the corresponding short link.

[Rest API] Get links by original URL (multiple)

Retrieves all short links that match a given original (destination) URL within a domain.

• Provide the domain ID and the original URL to return every short link pointing to that destination.

[Rest API] Get link info by path

Retrieves the details of a short link identified by its domain and path.

• Provide the domain and the link path (the slug after the domain) to expand it into the full link record.

[Rest API] Get link permissions

Retrieves the user permissions configured for a link within a domain.

• Provide the domain ID and the link ID to list which users have access to the link.

[Rest API] Get domain statistics

Retrieves aggregate click statistics for a domain.

• Provide the domain ID to fetch the domain's overall click analytics.

[Rest API] Get domain statistics with filters

Retrieves click statistics for a domain using filter criteria supplied in the request body.

• Provide the domain ID and filter parameters to return a narrowed view of the domain's click analytics.

[Rest API] Get link clicks for a domain

Retrieves click data for the links in a domain.

• Provide the domain ID to fetch click records across the domain's links.

[Rest API] Get link clicks by paths

Retrieves click data for specific link paths within a domain.

• Provide the domain ID and the target link paths in the request body to fetch click data for just those links.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

Short.io data sources can also be manually configured to ingest data from any valid Short.io API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Short.io data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination

Click the + icon on the Nexset that will be sent to the Short.io destination, and select the Send to Destination option from the menu. Select the Short.io connector from the list of available destination connectors, then select the credential that will be used to connect to Short.io, and click Next; or, create a new Short.io credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Short.io endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

[Rest API] Create a domain

Creates a new domain in your Short.io account using records from a Nexset.

• Each record is sent as a JSON request body describing the domain to create.

[Rest API] Update domain settings

Updates the settings of an existing domain identified by its domain ID.

• Provide the domain ID as the path parameter and send the updated settings in the JSON request body.

[Rest API] Create new link

Creates a new short link from records in a Nexset.

• Each record is sent as a JSON request body describing the link to create, including the destination URL and domain.

[Rest API] Create link using public API key

Creates a new short link using the public API key endpoint.

• Each record is sent as a JSON request body; this endpoint is intended for use with a public API key.

[Rest API] Create up to 1000 links

Creates multiple short links in a single request, up to 1000 links at a time.

• Send a JSON request body containing the array of links to create in bulk.

[Rest API] Update existing URL

Updates an existing short link identified by its link ID.

• Provide the link ID as the path parameter and send the updated link fields in the JSON request body.

[Rest API] Delete link

Deletes a short link identified by its link ID.

• Provide the link ID as the path parameter to permanently remove the link.

[Rest API] Delete links in bulk

Deletes multiple short links in a single request.

• Send a JSON request body containing the link identifiers to delete in bulk.

[Rest API] Archive link

Archives a short link.

• Send a JSON request body identifying the link to archive.

[Rest API] Archive links in bulk

Archives multiple short links in a single request.

• Send a JSON request body containing the links to archive in bulk.

[Rest API] Unarchive link

Restores a previously archived short link.

• Send a JSON request body identifying the link to unarchive.

[Rest API] Unarchive links in bulk

Restores multiple previously archived short links in a single request.

• Send a JSON request body containing the links to unarchive in bulk.

[Rest API] Generate QR code for a link

Generates a QR code for a short link identified by its link ID.

• Provide the link ID as the path parameter and send any QR code options in the JSON request body.

[Rest API] Generate QR codes in bulk

Generates QR codes for multiple short links in a single request.

• Send a JSON request body containing the links for which to generate QR codes.

[Rest API] Add link permission for a user

Grants a user permission to a link within a domain.

• Provide the domain ID, link ID, and user ID as path parameters to add the permission.

[Rest API] Delete link permission for a user

Removes a user's permission to a link within a domain.

• Provide the domain ID, link ID, and user ID as path parameters to revoke the permission.

[Rest API] Clear domain statistics

Clears the accumulated click statistics for a domain.

• Provide the domain ID as the path parameter to reset the domain's statistics.

Manual configuration

Short.io destinations can also be manually configured to send data to any valid Short.io API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

Short.io APIs expect JSON format for most write operations. For update operations, include the ID of the object to be updated at the end of the endpoint URL.

Save & activate

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Short.io endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the Short.io endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.