Endpoint API

Crea un link

POST https://urly.it/api/v1/links

Accorcia un nuovo link.

Parametri

Parametri da inviare nel payload JSON:

• destination è l’URL lungo che si desidera accorciare (obbligatorio).
• destination_android, destination_ios, destination_smartphone, destination_tablet: rispettivamente gli URL alternativi di destinazione se il link viene aperto su Android, iOS, uno smartphone generico o un tablet generico. Possono assumere valore null (facoltativi).
• password: una password per "sbloccare" il link (facoltativo).
• skip_interstitial: valore booleano. Se è true, il link è diretto senza pagina di anteprima (facoltativo, se non specificato assume di default il valore true per gli account Urly Plus).

Esempio minimale:

{
  "destination": "https://www.example.com"
}

Risposta

Viene restituito un oggetto data contenente tutti i dati del link.

Esempio minimale:

{
  "data": {
    "slug": "362",
    "url": "http:\/\/urly.it\/33",
    "url_without_protocol": "urly.it\/33",
    // ...
  }
}

L’oggetto di risposta intero è mostrato qui di seguito per l’endpoint "Mostra i dettagli di un link".

Mostra i dettagli di un link

GET https://urly.it/api/v1/links/{slug}

Mostra i dati di un proprio link.

Parametri

Parametri URL:

• {slug} è l'identificativo del link che si vuole visualizzare.

Risposta

data è un oggetto con i dati del link:

• created_at: data e ora di creazione in formato ISO.
• destination: l’URL di destinazione del link accorciato.
• destination_android, destination_ios, destination_smartphone, destination_tablet: rispettivamente gli URL alternativi di destinazione se il link viene aperto su Android, iOS, uno smartphone generico o un tablet generico. Assumono valore null se non sono specificati.
• password: la password per "sbloccare" il link qualora sia protetto da password. Altrimenti è null.
• qr_url: URL alla pagina del codice QR del link.
• qr_image_png: URL all’immagine del codice QR in formato PNG.
• qr_image_svg: URL all’immagine del codice QR in formato SVG.
• skip_interstitial: valore booleano. Se è true, il link è diretto senza pagina di anteprima.
• slug: l’identificativo del link.
• url: l’URL accorciato, completo di protocollo https://.
• url_without_protocol: l'URL accorciato, privo di protocollo https://.
• visits: un intero che indica il numero di aperture del link.

{
  "data": {
    "created_at": "2021-12-08T17:16:57.000000Z",
    "destination": "http:\/\/urly.it",
    "destination_android": "http:\/\/urly.it#example_link",
    "destination_ios": null,
    "destination_smartphone": null,
    "destination_tablet": null,
    "password": "secret",
    "qr_url": "http:\/\/urly.it\/qr\/33",
    "qr_image_png": "http:\/\/urly.it\/qr\/image\/33.png",
    "qr_image_svg": "http:\/\/urly.it\/qr\/image\/33.svg",
    "skip_interstitial": true,
    "slug": "33",
    "url": "http:\/\/urly.it\/33",
    "url_without_protocol": "urly.it\/33",
    "visits": 0
  }
}

Mostra tutti i link

GET https://urly.it/api/v1/links

Mostra una lista paginata dei link creati con il proprio account.

Parametri

Nessun parametro.

Risposta

• data è un array dei propri link.
• links è un oggetto con gli URL per scorrere lungo la paginazione (first è la prima pagina, last è l’ultima, prev è la precedente, next è la successiva).
• meta è un oggetto che contiene informazioni sulla paginazione (es. current_page è il numero di pagina attuale, last_page il numero dell’ultima pagina).

{
  "data": [
    {
      "created_at": "2022-01-01T08:00:00.000000Z",
      "destination": "http:\/\/urly.it",
      "destination_android": null,
      "destination_ios": null,
      "destination_smartphone": null,
      "destination_tablet": null,
      "password": null,
      "qr_url": "http:\/\/urly.it\/qr\/33",
      "qr_image_png": "http:\/\/urly.it\/qr\/image\/33.png",
      "qr_image_svg": "http:\/\/urly.it\/qr\/image\/33.svg",
      "skip_interstitial": true,
      "slug": "33",
      "url": "http:\/\/urly.it\/33",
      "url_without_protocol": "urly.it\/33",
      "visits": 0
    },
    // ...more links
  ],
  "links": {
    "first": "http:\/\/urly.it\/api\/v1\/links?page=1",
    "last": "http:\/\/urly.it\/api\/v1\/links?page=2",
    "prev": null,
    "next": "http:\/\/urly.it\/api\/v1\/links?page=2"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 2,
    "links": [
      {
        "url": null,
        "label": "Indietro",
        "active": false
      },
      {
        "url": "http:\/\/urly.it\/api\/v1\/links?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": "http:\/\/urly.it\/api\/v1\/links?page=2",
        "label": "2",
        "active": false
      },
      {
        "url": "http:\/\/urly.it\/api\/v1\/links?page=2",
        "label": "Avanti",
        "active": false
      }
    ],
    "path": "http:\/\/urly.it\/api\/v1\/links",
    "per_page": 10,
    "to": 10,
    "total": 19
  }
}

Mostra utente

GET https://urly.it/api/v1/user

Mostra i dati del proprio utente.

Parametri

Nessun parametro.

Risposta

data è un oggetto con i dati dell'utente.

{
  "data": {
    "email": "[email protected]",
    "name": "John Doe"
  }
}