ONTWIKKELAARSREFERENTIE

URLZ.li API-documentatie

Authenticatie, korte links, uploads van bestanden en foto’s, klikstatistieken en betaallink-API’s met direct bruikbare voorbeelden.

01

Overzicht

Bouw korte links, uploads, statistieken en betaalde toegang met de URLZ-API. Deze referentie scheidt serverintegraties met API-sleutel van aangemelde accountsessies.

Server-naar-server

Gebruik je actieve sleutel vanuit een backend, automatisering of intern hulpmiddel.

apikey=YOUR_API_KEY

Accountsessie

Gebruik Bearer voor accountlinks, uploads, statistieken en inkomsten.

Authorization: Bearer …
02

Snel starten

Maak in drie stappen je eerste korte link en gebruik daarna de volledige referentie.

  1. 1
    Account maken

    Open het dashboard en activeer een API-abonnement.

  2. 2
    API-sleutel kopiëren

    Bewaar hem op je server en nooit in openbare code.

  3. 3
    Verzoek verzenden

    Stuur de bestemming en lees result.short_url uit de JSON-respons.

Curl
curl -X POST "https://api.urlz.li/url/create" \
  --data-urlencode "apikey=YOUR_API_KEY" \
  --data-urlencode "fullUrl=https://example.com/private-report"
03

Authenticatie

URLZ ondersteunt twee authenticatiemethoden. Kies wat bij je integratie past.

A

API-sleutel

Voor backends. Stuur apikey in de URL of formulierbody; sleutel en abonnement moeten actief zijn.

apikey=YOUR_API_KEY
B

Bearer-sessie

Voor accountfuncties. Vraag een token op bij aanmelden en stuur dit in Authorization.

Authorization: Bearer SESSION_TOKEN
Bewaar inloggegevens op de server

Publiceer nooit sleutels, wachtwoorden of tokens in JavaScript, logs, versiebeheer of openbare repositories.

04

Endpointoverzicht

Kies een endpoint voor parameters en voorbeelden.

05

API-sleutel-endpoints

Stabiele serverroutes om korte links te maken en zoeken.

06

Account-endpoints

Accountlinks, uploads, klikken en verwijderen.

POST/mobile/v1/auth/login.php

Accountsessie openen

Wisselt accountgegevens in voor Bearer-token.

Geen authenticatie

Parameters

ParameterTypeVerplichtStandaard
emailemailJa—
passwordstringJa—
Verzoek
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"}'
Respons
{
  "token": "SESSION_TOKEN",
  "user": {
    "id": 42,
    "email": "developer@example.com",
    "apiKey": "ACCOUNT_API_KEY",
    "planActive": true
  }
}
POST/mobile/v1/shorten.php

Accountlink maken

Maakt gewone of beveiligde link; Bearer is optioneel behalve met wachtwoord.

Optioneel Bearer-token

Parameters

ParameterTypeVerplichtStandaard
urlURLJa—
passwordstring (min. 4)Nee—
Verzoek
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"}'
Respons
{
  "shortUrl": "https://urlz.li/Ab3dE91x",
  "destination": "https://example.com/private",
  "hash": "Ab3dE91x",
  "protected": true
}
POST/mobile/v1/upload.php

Bestand of foto uploaden

Uploadt toegestaan bestand tot 10 MB.

Optioneel Bearer-token

Parameters

ParameterTypeVerplichtStandaard
filemultipart fileJa—
kindphoto | documentNeedocument
passwordstring (min. 4)Nee—
Verzoek
curl -X POST "https://api.urlz.li/mobile/v1/upload.php" \
  -H "Authorization: Bearer SESSION_TOKEN" \
  -F "file=@./photo.jpg" \
  -F "kind=photo"
Respons
{
  "shortUrl": "https://urlz.li/P8kLm21q",
  "destination": "https://urlz.li/cloud/app/photo_….jpg",
  "hash": "P8kLm21q",
  "protected": false
}
GET/mobile/v1/clicks.php

Klikstatistieken lezen

Geeft klikken, bezoekers, landen en gebeurtenissen.

Bearer

Parameters

ParameterTypeVerplichtStandaard
linkIdintegerJa—
limitinteger (1–100)Nee100
offsetintegerNee0
Verzoek
curl "https://api.urlz.li/mobile/v1/clicks.php?linkId=1204&limit=25" \
  -H "Authorization: Bearer SESSION_TOKEN"
Respons
{
  "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": []
}
07

URLZ Chat & Request

Add private conversations, collect requested documents, schedule reminders and track submissions.

POST/mobile/v1/collaboration/configure.php

Enable 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 key

Parameters

ParameterTypeVerplichtStandaard
hashstringJa—
chat.enabledbooleanNeefalse
request.enabledbooleanNeefalse
request.titlestringNee—
request.itemsstring[]Nee[]
request.recipientsemail[]Nee[]
request.deadlineISO datetimeNee—
request.paymentRequiredbooleanNeefalse
Verzoek
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"]}}'
Respons
{"featureId":14,"hash":"7b3c2e5a","chatEnabled":true,"requestEnabled":true}
GET/mobile/v1/collaboration/chats.php

List link conversations

Return chat-enabled links and message totals. Add id to retrieve messages.

Bearer

Parameters

ParameterTypeVerplichtStandaard
idintegerNee—
afterintegerNee0
Verzoek
curl "https://api.urlz.li/mobile/v1/collaboration/chats.php?id=14" \
  -H "Authorization: Bearer SESSION_TOKEN"
Respons
{"items":[{"id":14,"hash":"7b3c2e5a","messageCount":3,"messages":[]}]}
GET/mobile/v1/collaboration/requests.php

Track document requests

List requests, expected items, recipients, submissions and secure files. Add id for full detail.

Bearer

Parameters

ParameterTypeVerplichtStandaard
idintegerNee—
Verzoek
curl "https://api.urlz.li/mobile/v1/collaboration/requests.php?id=14" \
  -H "Authorization: Bearer SESSION_TOKEN"
Respons
{"items":[{"id":14,"title":"Accounting documents","recipients":1,"submissions":1,"files":2}]}
08

Fouten en HTTP-codes

Moderne endpoints geven message terug; API-sleutelroutes gebruiken error. Baseer logica op de HTTP-status.

{ "message": "A valid link is required." }{ "error": "Invalid API key" }
200
Geslaagd

Verzoek voltooid.

201
Aangemaakt

Link of bestand gemaakt.

400
Ongeldig verzoek

JSON of syntaxis is ongeldig.

401
Aanmelding vereist

Token ontbreekt of is verlopen.

403
Verboden

Sleutel, abonnement of account heeft geen toegang.

404
Niet gevonden

Bron bestaat niet.

409
Conflict

Status conflicteert.

422
Validatie mislukt

Velden ontbreken of zijn ongeldig.

429
Te veel verzoeken

Vertraag en probeer later.

500/503
Server niet beschikbaar

Probeer later idempotent opnieuw.

09

Beveiliging en limieten

Pas deze regels toe in productie.

  • Gebruik uitsluitend HTTPS.
  • Houd API-sleutels privé en vernieuw ze regelmatig.
  • Valideer en codeer parameters van gebruikers.
  • Gebruik paginering voor lijsten en logs.
  • Aanbevolen maximum: 10 verzoeken per seconde per sleutel.
Hulp nodig?

Stuur endpoint, HTTP-status en een opgeschoond voorbeeld zonder gegevens.

URLZ VOOR iPHONE

De nieuwe iOS-versie komt er bijna aan

De bijgewerkte URLZ-app voor iPhone wordt afgerond en verschijnt in de komende dagen in de App Store. Bedankt voor je geduld.