API Reference for Developersv1
Welcome to the App Opener API reference. An API key is required for requests to be processed by the system.
Getting Started
An API key is required for requests to be processed by the system. Once a user registers, an API key is automatically generated for this user. The API key must be sent with each request (see full example below). If the API key is not sent or is expired, there will be an error. Please make sure to keep your API key secret to prevent abuse.
Authentication
To authenticate with the API system, you need to send your API key as an authorization token with each request. You can see sample code below.
Rate Limit
Our API has a rate limiter to safeguard against spike in requests to maximize its stability. Our rate limiter is currently capped at 30 requests per 1 minute. Please note that the rate might change according to the subscribed plan. Several headers will be sent alongside the response and these can be examined to determine various information about the request.
Response Handling
All API responses are returned in JSON format by default. In JavaScript, response.json() or JSON.parse() can be used to parse the returned data into an object. It is very important to check the success key as that provides information on whether there was an error or not. You can also check the HTTP status code.
{
"success": false,
"message": "An error occurred"
}API Endpoints Reference
Create App Opener Link
Generates a smart deep link for any target web URL. Opens directly inside the target native app on iOS and Android.
Body Parameters (JSON)
| Field | Type | Required | Description |
|---|---|---|---|
| url | string | REQUIRED | Destination URL to shorten and convert into a smart deep link. Example: "https://youtu.be/dQw4w9WgXcQ?si=dcUc-CeILVK4Ylbp" |
| custom | string | OPTIONAL | Optional custom slug / back-half alias. Example: "custom-alias" |
curl -X POST "https://api-appopener.recut.in/v1/api/url/add" \ -H "Authorization: Bearer YOUR_API_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "url": "https://youtu.be/dQw4w9WgXcQ?si=dcUc-CeILVK4Ylbp", "custom": "custom-alias" }'
{
"success": true,
"message": "App Opener link created successfully.",
"data": {
"id": "6a7ca2570789804502348aaf",
"shorturl": "http://localhost:3000/custom-alias"
}
}
