Documentation
Developer API
Create short links from approved integrations with a developer API key.
Developer API
Use the Developer API when an approved backend service needs to create URLNow short links automatically.
The Developer API uses a developer API key from the Developer console. Store the key server-side and restrict access to authorized systems.
API capability
The Developer API creates short links for approved integrations.
Use Create short link for manual link creation. Use the developer key endpoint below for approved automated link creation.
Before you start
- Create a URLNow account from Register.
- Open the Developer console.
- Submit a developer access request.
- Wait for approval.
- Create a developer API key.
- Store the key securely on your server.
Do not place developer API keys in browser JavaScript, mobile apps, public repositories, or any place users can inspect.
Base URL
https://urlnow.me/api
Send this header with requests:
Accept: application/json
Create a short link
POST /api/short-url/{key}
Replace {key} with your developer API key.
curl -X POST https://urlnow.me/api/short-url/YOUR_DEVELOPER_KEY \
-H "Accept: application/json" \
-d "long_url=https://example.com/product" \
-d "alias=product-launch"
Request fields
| Field | Required | Notes |
|---|---|---|
long_url |
Yes | Destination URL. If no scheme is provided, URLNow adds https://. |
alias |
No | Custom ending. Use 3 to 64 letters, numbers, hyphens, or underscores. |
If alias is left blank, URLNow creates a custom ending automatically.
Successful response
{
"success": true,
"url": {
"long_url": "https://example.com/product",
"alias": "product-launch",
"shorten_url": "https://urlnow.me/product-launch"
}
}
Custom ending rules
Custom endings:
- Must be unique.
- Must use 3 to 64 characters.
- May contain letters, numbers, hyphens, and underscores.
- Cannot use reserved platform words such as
app,api,login,register, orpricing.
Choose custom endings that are short, readable, and meaningful for your campaign or workflow.
Link safety
URLNow validates destinations before creating short links. A request may be rejected if the destination is:
- Missing or invalid.
- A private or local address.
- Blocked by safety checks.
- Too long.
Developer key approval
Developer keys work only when the account's developer access request is approved.
If access is pending, rejected, or revoked, requests with that key will not create short links.
Common errors
| Status | Meaning |
|---|---|
403 |
The developer profile is not approved for this API key. |
404 |
The developer API key was not found. |
422 |
The destination URL or custom ending is invalid. |
500 |
URLNow could not complete the request. Try again later. |
Integration checklist
- Request approval before launching an integration.
- Keep the developer API key on your server only.
- Validate destination URLs in your app before sending them to URLNow.
- Handle
403,404,422, and500responses. - Rotate the key from the developer console if it may have been exposed.
- Use descriptive custom endings for campaign and customer-facing links.