Présentation
Créez des parcours de liens courts, d’envoi de fichiers, de statistiques et d’accès payant avec l’API URLZ. Cette référence sépare les intégrations serveur par clé API des sessions de compte authentifiées.
Serveur à serveur
Utilisez votre clé API active pour créer et rechercher des liens depuis un backend, une automatisation ou un outil interne.
apikey=YOUR_API_KEYSession de compte
Utilisez une session Bearer pour les liens du compte, les fichiers, les statistiques et la monétisation.
Authorization: Bearer …Démarrage rapide
Créez votre premier lien court en trois étapes, puis utilisez la référence détaillée pour la production.
- 1Créer un compte
Ouvrez la dashboard et activez un abonnement API.
- 2Copier votre clé API
Conservez-la sur votre serveur et ne l’exposez jamais dans du code public.
- 3Envoyer la requête
Envoyez la destination puis lisez result.short_url dans la réponse JSON.
curl -X POST "https://api.urlz.li/url/create" \
--data-urlencode "apikey=YOUR_API_KEY" \
--data-urlencode "fullUrl=https://example.com/private-report"
// Server-side JavaScript (Node.js)
const body = new URLSearchParams({
apikey: 'YOUR_API_KEY',
fullUrl: 'https://example.com/private-report'
});
const response = await fetch('https://api.urlz.li/url/create', {
method: 'POST',
body
});
const data = await response.json();
console.log(data.result.short_url);
$request = curl_init('https://api.urlz.li/url/create');
curl_setopt_array($request, [
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => http_build_query([
'apikey' => 'YOUR_API_KEY',
'fullUrl' => 'https://example.com/private-report',
]),
CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($request), true, 512, JSON_THROW_ON_ERROR);
echo $data['result']['short_url'];
import requests
response = requests.post(
"https://api.urlz.li/url/create",
data={
"apikey": "YOUR_API_KEY",
"fullUrl": "https://example.com/private-report",
},
timeout=15,
)
response.raise_for_status()
print(response.json()["result"]["short_url"])
Authentification
URLZ accepte deux modes d’authentification. Choisissez celui qui correspond à votre intégration.
Clé API
Pour les intégrations backend. Envoyez apikey dans la chaîne de requête ou le corps du formulaire. La clé et l’abonnement doivent être actifs.
apikey=YOUR_API_KEYSession Bearer
Pour les fonctions du compte. Obtenez un jeton via la route de connexion et transmettez-le dans l’en-tête Authorization.
Authorization: Bearer SESSION_TOKENNe publiez jamais une clé API, un mot de passe ou un jeton Bearer dans du JavaScript, des journaux mobiles, Git ou un dépôt public.
Index des routes
Choisissez une route pour accéder directement à ses paramètres et à ses exemples de requête et de réponse.
/url/createCréer un lien court
GET/url/listLister et filtrer les liens
POST/mobile/v1/auth/login.phpOuvrir une session de compte
POST/mobile/v1/shorten.phpCréer un lien lié au compte
POST/mobile/v1/upload.phpImporter un fichier ou une photo
GET/mobile/v1/links.phpLister les liens du compte
GET/mobile/v1/clicks.phpConsulter les statistiques de clics
DELETE/mobile/v1/delete-link.phpSupprimer un lien
POST/mobile/v1/collaboration/configure.phpEnable URLZ Chat or URLZ Request
GET/mobile/v1/collaboration/chats.phpList link conversations
GET/mobile/v1/collaboration/requests.phpTrack document requests
POST/mobile/v1/monetization/links.phpCréer ou convertir un lien payant
POST/mobile/v1/monetization/upload.phpCréer un fichier ou une photo payante
GET/mobile/v1/monetization/links.phpLister les liens payants
GET/mobile/v1/monetization/transactions.phpLister les ventes des liens payants
Routes par clé API
Routes serveur à serveur stables pour créer et rechercher des liens courts.
/url/createCréer un lien court
Crée une URL courte avec une clé API active.
apikeyParamètres
| Paramètre | Type | Obligatoire | Par défaut |
|---|---|---|---|
apikey | string | Oui | — |
fullUrl | URL | Oui | — |
encrypt | string | Non | "" |
password | string | Non | "" |
curl -X POST "https://api.urlz.li/url/create" \
--data-urlencode "apikey=YOUR_API_KEY" \
--data-urlencode "fullUrl=https://example.com/report.pdf"
{
"result": {
"short_url": "https://urlz.li/7b3c2e5a",
"hash": "7b3c2e5a",
"date": "2026-11-02",
"time": "14:32:10"
}
}
/url/listLister et filtrer les liens
Renvoie les liens d’une clé API avec filtres et pagination.
apikeyParamètres
| Paramètre | Type | Obligatoire | Par défaut |
|---|---|---|---|
apikey | string | Oui | — |
limit | integer (1–1000) | Non | 100 |
offset | integer | Non | 0 |
order | asc | desc | Non | desc |
date | YYYY-MM-DD | Non | — |
from_date | YYYY-MM-DD | Non | — |
to_date | YYYY-MM-DD | Non | — |
url_destination | string | Non | — |
hash | string | Non | — |
curl -G "https://api.urlz.li/url/list" \
--data-urlencode "apikey=YOUR_API_KEY" \
--data-urlencode "limit=25" \
--data-urlencode "order=desc"
{
"result": {
"filters": { "limit": 25, "offset": 0, "order": "desc" },
"total": 42,
"count": 25,
"items": [
{
"id": 1204,
"date": "2026-11-02",
"time": "14:32:10",
"destination": "https://example.com/report.pdf",
"hash": "7b3c2e5a",
"hash_retour": "https://urlz.li/7b3c2e5a"
}
]
}
}
Routes du compte
Liens du compte, fichiers, statistiques de clics et suppression.
/mobile/v1/auth/login.phpOuvrir une session de compte
Échange les identifiants du compte contre un jeton de session Bearer.
Aucune authentificationParamètres
| Paramètre | Type | Obligatoire | Par défaut |
|---|---|---|---|
email | Oui | — | |
password | string | Oui | — |
curl -X POST "https://api.urlz.li/mobile/v1/auth/login.php" \
-H "Content-Type: application/json" \
-d '{"email":"developer@example.com","password":"YOUR_PASSWORD"}'
{
"token": "SESSION_TOKEN",
"user": {
"id": 42,
"email": "developer@example.com",
"apiKey": "ACCOUNT_API_KEY",
"planActive": true
}
}
/mobile/v1/shorten.phpCréer un lien lié au compte
Crée un lien normal ou protégé par mot de passe. Le jeton Bearer est facultatif sauf si un mot de passe est utilisé.
Jeton Bearer facultatifParamètres
| Paramètre | Type | Obligatoire | Par défaut |
|---|---|---|---|
url | URL | Oui | — |
password | string (min. 4) | Non | — |
curl -X POST "https://api.urlz.li/mobile/v1/shorten.php" \
-H "Authorization: Bearer SESSION_TOKEN" \
-H "Content-Type: application/json" \
-d '{"url":"https://example.com/private","password":"safe-pass"}'
{
"shortUrl": "https://urlz.li/Ab3dE91x",
"destination": "https://example.com/private",
"hash": "Ab3dE91x",
"protected": true
}
/mobile/v1/upload.phpImporter un fichier ou une photo
Importe un fichier autorisé de 10 Mo maximum et renvoie une URL courte.
Jeton Bearer facultatifParamètres
| Paramètre | Type | Obligatoire | Par défaut |
|---|---|---|---|
file | multipart file | Oui | — |
kind | photo | document | Non | document |
password | string (min. 4) | Non | — |
curl -X POST "https://api.urlz.li/mobile/v1/upload.php" \
-H "Authorization: Bearer SESSION_TOKEN" \
-F "file=@./photo.jpg" \
-F "kind=photo"
{
"shortUrl": "https://urlz.li/P8kLm21q",
"destination": "https://urlz.li/cloud/app/photo_….jpg",
"hash": "P8kLm21q",
"protected": false
}
/mobile/v1/links.phpLister les liens du compte
Liste les liens, les clics, la protection et l’état de monétisation du compte connecté.
BearerParamètres
| Paramètre | Type | Obligatoire | Par défaut |
|---|---|---|---|
limit | integer (1–100) | Non | 100 |
offset | integer | Non | 0 |
curl "https://api.urlz.li/mobile/v1/links.php?limit=25&offset=0" \
-H "Authorization: Bearer SESSION_TOKEN"
{
"items": [
{
"id": 1204,
"shortUrl": "https://urlz.li/7b3c2e5a",
"destination": "https://example.com/report.pdf",
"protected": false,
"monetized": true,
"clicks": 18
}
],
"total": 42,
"summary": { "totalLinks": 42, "totalClicks": 304, "clicksLast7Days": 28 }
}
/mobile/v1/clicks.phpConsulter les statistiques de clics
Renvoie les clics, les visiteurs uniques, les principaux pays et les accès paginés.
BearerParamètres
| Paramètre | Type | Obligatoire | Par défaut |
|---|---|---|---|
linkId | integer | Oui | — |
limit | integer (1–100) | Non | 100 |
offset | integer | Non | 0 |
curl "https://api.urlz.li/mobile/v1/clicks.php?linkId=1204&limit=25" \
-H "Authorization: Bearer SESSION_TOKEN"
{
"link": { "id": 1204, "shortUrl": "https://urlz.li/7b3c2e5a" },
"summary": {
"totalClicks": 18,
"uniqueVisitors": 14,
"clicksLast24Hours": 2,
"clicksLast7Days": 9
},
"countries": [{ "country": "France", "countryCode": "FR", "clicks": 8 }],
"items": []
}
/mobile/v1/delete-link.phpSupprimer un lien
Supprime uniquement le lien appartenant au compte authentifié.
BearerParamètres
| Paramètre | Type | Obligatoire | Par défaut |
|---|---|---|---|
hash | string | Oui | — |
curl -X DELETE "https://api.urlz.li/mobile/v1/delete-link.php" \
-H "Authorization: Bearer SESSION_TOKEN" \
-H "Content-Type: application/json" \
-d '{"hash":"7b3c2e5a"}'
{
"ok": true,
"message": "Link deleted."
}
URLZ Chat & Request
Add private conversations, collect requested documents, schedule reminders and track submissions.
/mobile/v1/collaboration/configure.phpEnable URLZ Chat or URLZ Request
Attach a private conversation and/or a document request to an existing account link. A Bearer session token or API key is accepted.
Bearer or API keyParamètres
| Paramètre | Type | Obligatoire | Par défaut |
|---|---|---|---|
hash | string | Oui | — |
chat.enabled | boolean | Non | false |
request.enabled | boolean | Non | false |
request.title | string | Non | — |
request.items | string[] | Non | [] |
request.recipients | email[] | Non | [] |
request.deadline | ISO datetime | Non | — |
request.paymentRequired | boolean | Non | false |
curl -X POST "https://api.urlz.li/mobile/v1/collaboration/configure.php" \
-H "Authorization: Bearer SESSION_TOKEN" \
-H "Content-Type: application/json" \
-d '{"hash":"7b3c2e5a","chat":{"enabled":true},"request":{"enabled":true,"title":"Accounting documents","items":["Invoices","Bank statement"]}}'
{"featureId":14,"hash":"7b3c2e5a","chatEnabled":true,"requestEnabled":true}
/mobile/v1/collaboration/chats.phpList link conversations
Return chat-enabled links and message totals. Add id to retrieve messages.
BearerParamètres
| Paramètre | Type | Obligatoire | Par défaut |
|---|---|---|---|
id | integer | Non | — |
after | integer | Non | 0 |
curl "https://api.urlz.li/mobile/v1/collaboration/chats.php?id=14" \
-H "Authorization: Bearer SESSION_TOKEN"
{"items":[{"id":14,"hash":"7b3c2e5a","messageCount":3,"messages":[]}]}
/mobile/v1/collaboration/requests.phpTrack document requests
List requests, expected items, recipients, submissions and secure files. Add id for full detail.
BearerParamètres
| Paramètre | Type | Obligatoire | Par défaut |
|---|---|---|---|
id | integer | Non | — |
curl "https://api.urlz.li/mobile/v1/collaboration/requests.php?id=14" \
-H "Authorization: Bearer SESSION_TOKEN"
{"items":[{"id":14,"title":"Accounting documents","recipients":1,"submissions":1,"files":2}]}
Routes des liens payants
Créez des accès payants et consultez les ventes d’un compte créateur authentifié.
/mobile/v1/monetization/links.phpCréer ou convertir un lien payant
Crée une URL payante ou transforme un lien existant en accès payant.
BearerParamètres
| Paramètre | Type | Obligatoire | Par défaut |
|---|---|---|---|
destination | URL | Non | — |
existingLinkId | integer | Non | — |
title | string (max. 180) | Oui | — |
description | string (max. 3000) | Non | — |
price | decimal | Oui | — |
currency | EUR | USD | Oui | USD |
accessPolicy | permanent | timed | limited | Non | permanent |
accessDurationHours | integer (1–8760) | Non | 24 |
maxAccesses | integer (1–1000) | Non | 1 |
locale | ISO 639-1 | Non | en |
curl -X POST "https://api.urlz.li/mobile/v1/monetization/links.php" \
-H "Authorization: Bearer SESSION_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"destination":"https://example.com/private-course",
"title":"Private course access",
"description":"One-time access to the course.",
"price":"9.90",
"currency":"EUR",
"accessPolicy":"permanent",
"locale":"en"
}'
{
"id": 91,
"hash": "cd3ed9a4",
"shortUrl": "https://urlz.li/cd3ed9a4",
"paywallUrl": "https://urlz.li/en/pay/cd3ed9a4/",
"converted": false
}
/mobile/v1/monetization/upload.phpCréer un fichier ou une photo payante
Stocke un fichier de manière privée et crée un lien court payant. Taille maximale : 50 Mo.
BearerParamètres
| Paramètre | Type | Obligatoire | Par défaut |
|---|---|---|---|
file | multipart file | Oui | — |
kind | photo | file | Non | file |
title | string (max. 180) | Oui | — |
description | string (max. 3000) | Non | — |
price | decimal | Oui | — |
currency | EUR | USD | Oui | USD |
accessPolicy | permanent | timed | limited | Non | permanent |
locale | ISO 639-1 | Non | en |
curl -X POST "https://api.urlz.li/mobile/v1/monetization/upload.php" \
-H "Authorization: Bearer SESSION_TOKEN" \
-F "file=@./premium-photo.jpg" \
-F "kind=photo" \
-F "title=Premium event photo" \
-F "price=4.90" \
-F "currency=EUR"
{
"id": 92,
"hash": "e71f8a20",
"shortUrl": "https://urlz.li/e71f8a20",
"paywallUrl": "https://urlz.li/en/pay/e71f8a20/"
}
/mobile/v1/monetization/links.phpLister les liens payants
Renvoie les liens payants avec ventes, chiffre brut, revenu net et statut.
Bearercurl "https://api.urlz.li/mobile/v1/monetization/links.php" \
-H "Authorization: Bearer SESSION_TOKEN"
{
"items": [
{
"id": 91,
"shortUrl": "https://urlz.li/cd3ed9a4",
"kind": "url",
"priceMinor": 990,
"currency": "EUR",
"status": "active",
"sales": 4,
"grossMinor": 3960,
"netMinor": 3374
}
]
}
/mobile/v1/monetization/transactions.phpLister les ventes des liens payants
Renvoie les commandes, frais Stripe, frais URLZ, revenu net et dates de libération des fonds.
Bearercurl "https://api.urlz.li/mobile/v1/monetization/transactions.php" \
-H "Authorization: Bearer SESSION_TOKEN"
{
"items": [
{
"orderNumber": "LNK-20261102-8F3C21",
"grossMinor": 990,
"platformFeeMinor": 69,
"processorFeeMinor": 45,
"netMinor": 876,
"currency": "EUR",
"status": "paid",
"fundsAvailableAt": "2026-11-16 14:32:10",
"fundsStatus": "held"
}
]
}
Erreurs et codes HTTP
Les routes modernes renvoient un objet JSON avec message. Les routes par clé API utilisent error. Basez toujours votre logique sur le statut HTTP et non sur le texte du message.
{ "message": "A valid link is required." }{ "error": "Invalid API key" }La requête s’est terminée correctement.
Le lien ou le fichier a été créé.
JSON incorrect ou syntaxe de requête invalide.
Le jeton Bearer est absent ou expiré.
La clé API, l’abonnement ou le compte ne permet pas cette action.
Le lien ou la ressource n’existe pas.
L’état demandé entre en conflit avec une ressource existante.
Un ou plusieurs champs sont absents ou invalides.
Ralentissez puis réessayez avec un délai progressif.
Réessayez plus tard en gardant la requête idempotente.
Sécurité et limites
Appliquez ces règles à toute intégration en production.
- Utilisez uniquement HTTPS.
- Gardez vos clés API privées et renouvelez-les régulièrement.
- Validez et encodez les paramètres fournis par les utilisateurs.
- Utilisez la pagination pour les listes et journaux.
- Maximum recommandé : 10 requêtes par seconde et par clé.
Envoyez la route, le statut HTTP et un exemple de requête nettoyé. Ne transmettez jamais vos identifiants.
