OpenShort.Link Logo

On This Page

API Integration

Creating an API Key

Step: Navigate to API Keys

  1. Click "Integrations" in the sidebar
  2. Click "API Keys" in the Integrations submenu
  3. You'll see the API Keys page with a table of existing keys

Step: Open Create Modal

  1. Click the "Create API Key" button in the page header
  2. The Create API Key modal will open

Step: Enter Key Name

  1. In the "Name" field, enter a descriptive name (e.g., "Production API Key", "Development Key")
  2. This helps you identify the key later

Step: Configure Domain Scope

  1. In the "Domain Scope" multi-select dropdown, select one or more domains
  2. Options:

- Select specific domains: Key can only access those domains

- Leave empty: Key can access all domains

  1. Important: Domain scoping restricts which domains the API key can manage

Step: Configure IP Whitelist

  1. Allow All IPs (default):

- Check "Allow All IP Addresses" checkbox

- Key can be used from any IP address

  1. Restrict by IP:

- Uncheck "Allow All IP Addresses"

- An IP Whitelist textarea will appear

- Enter one IP address per line (e.g., 192.168.1.1)

- Only requests from these IPs will be accepted

Step: Set Expiration

  1. Never Expire (default):

- Check "Never Expire" checkbox

- Key remains valid indefinitely

  1. Set Expiration:

- Uncheck "Never Expire"

- An expiration date field will appear

- Select date and time when the key should expire

- Key will automatically become invalid after expiration

Step: Create the Key

  1. Review all settings
  2. Click the "Create API Key" button
  3. IMPORTANT: The API key will be displayed only once

Step: Save the API Key

  1. The key will appear in a highlighted box
  2. Click the "Copy" button to copy it to your clipboard
  3. Save it securely - it will not be shown again
  4. Store it in a password manager or secure location
  5. Click "OK" or close the modal

Security Best Practices

  1. Never share API keys publicly
  2. Use different keys for different environments
  3. Rotate keys regularly
  4. Use IP whitelisting for production keys
  5. Set expiration dates for temporary keys

Editing an API Key

Step: Open Edit Modal

  1. On the API Keys page, find the key you want to edit
  2. Click the "Edit" button in the Actions column
  3. The Edit API Key modal will open (same as Create)

Step: Modify Settings

  1. You can change: Name, Domain Scope, IP Whitelist, Expiration
  2. You cannot change: The actual key value (create a new key if needed)

Step: Save Changes

  1. Click the "Update API Key" button
  2. Changes will be saved immediately

Revoking/Deleting an API Key

Step: Delete Key

  1. On the API Keys page, find the key you want to revoke
  2. Click the "Delete" or "Revoke" button in the Actions column
  3. A confirmation dialog will appear

Step: Confirm Deletion

  1. Read the confirmation message
  2. Click "OK" to confirm or "Cancel" to abort
  3. If confirmed, the key will be immediately invalidated
  4. Any applications using this key will stop working
Warning: This action cannot be undone. You'll need to create a new key and update your applications.

Using the API Playground

Step: Navigate to Manual Integration

  1. Click "Integrations" in the sidebar
  2. Click "Manual Integration" in the Integrations submenu
  3. Scroll down to the "API Playground" section

Step: Enter API Key

  1. In the "API Key" field, paste your API key
  2. The system will validate the key and show information about it
  3. If domain scoping is active, a warning will appear

Step: Select Endpoint

  1. In the "Select Endpoint" dropdown, choose an API endpoint
  2. The request builder will appear below

Step: Configure Request

Path Parameters

  1. If the endpoint requires path parameters (like /links/:id), input fields will appear
  2. Enter the required values (e.g., link ID)

Query Parameters

  1. If the endpoint accepts query parameters, input fields will appear
  2. Enter optional parameters (e.g., limit, offset, search)

Request Body

  1. For POST/PUT requests, a JSON editor will appear
  2. Enter your request body in valid JSON format
  3. Validation errors will be shown if JSON is invalid

File Upload

  1. For file upload endpoints, a file input will appear
  2. Select the file to upload

Step: Review Request

  1. Check the "Request Preview" section
  2. Verify the HTTP method and URL are correct
  3. Review all parameters and body content

Step: Send Request

  1. Click the "Send Request" button
  2. The button will show "Sending..." while processing
  3. Wait for the response

Step: View Response

  1. The response section will appear below
  2. Status Code: Color-coded status badge
  3. Response Body: Formatted JSON display
  4. Actions:

- Click "Copy cURL" to copy a cURL command

- Click "Copy Response" to copy the response JSON

Step: View Request History

  1. Scroll to the "Request History" sidebar
  2. See a list of all requests you've made
  3. Click on a history item to replay that request
  4. Click "Clear History" to remove all history

Understanding API Documentation

Step: View Documentation

  1. On the Manual Integration page, scroll to the "API Documentation" section
  2. Documentation is organized by endpoint groups

Step: Explore Endpoints

  1. Click on endpoint groups to expand them
  2. Each endpoint shows:

- HTTP method and path

- Description

- Authentication requirements

- Path parameters

- Query parameters

- Request body schema

- Response schema

- Example requests

Step: Copy Documentation

  1. Click "Copy LLM.txt" to copy LLM-formatted documentation
  2. Click "Copy openapi.json" to copy OpenAPI specification
  3. Use these for integration with other tools

---

← Tags & Categories Settings →