Misi.Link

Dokumentacija API

Pošiljajte datoteke iz lastnih orodij (skripte, programi, strežniki): ustvarite prenos, naložite datoteke po delih, prejmite povezavo.

Ključ je na voljo v paketih Pro in Business, v razdelku Moj račun › API. Cenik

Preverjanje pristnosti

Ustvarite ključ v razdelku Moj račun › API in ga pošljite v glavi Authorization vsake zahteve. Hranite ga na skrivnem: omogoča dostop do vaših prenosov. Izbrisan ključ takoj preneha delovati.

Authorization: Bearer mlk_…

Če vaše orodje ali gostovanje ne posreduje glave Authorization, pošljite isti ključ v glavi X-API-Key:

X-API-Key: mlk_…

120 zahtev na minuto na ključ. Velikost, število datotek in čas razpoložljivosti: po vašem paketu.

Pošiljanje datotek v treh korakih

1. Ustvarite prenos

Navedite seznam datotek (ime in velikost v bajtih). Z »recipients« vsak prejemnik prejme e-pošto; brez prejemnikov dobite povezavo za deljenje. Neobvezno: »message«, »password«, »expire_days«, »delete_after_download«.

curl -X POST https://misi.link/api/v1/transfers \
  -H "Authorization: Bearer $MISILINK_KEY" -H "Content-Type: application/json" \
  -d '{"files": [{"name": "film.mov", "size": 5368709120}],
       "recipients": ["client@example.com"], "message": "…", "expire_days": 14}'
{"ok": true, "id": "aB3dE5fG", "token": "…", "url": "https://misi.link/aB3dE5fG",
 "files": [{"id": 101, "name": "film.mov", "size": 5368709120}], "chunk_size": 8388608}

2. Naložite datoteke

Vsako datoteko pošljite po delih z največ »chunk_size« bajtov, po vrsti: »offset« je število že prejetih bajtov te datoteke. Po prekinitvi »status« pove, kje nadaljevati (odgovor 409: nadaljujte pri »received«). Če vaše gostovanje ali požarni zid filtrira naslove, pošljite položaj v glavi X-Upload-Offset namesto v naslovu.

curl -X POST "https://misi.link/api/upload/chunk?id=aB3dE5fG&token=…&file=101&offset=0" \
  -H "Content-Type: application/octet-stream" --data-binary @morceau-1.bin
# {"ok": true, "received": 8388608, "done": false}

curl "https://misi.link/api/upload/status?id=aB3dE5fG&token=…"

3. Zaključite

Ko so prejete vse datoteke, zaključite: prenos se objavi in e-poštna sporočila se pošljejo. Povezava je tista iz prvega odgovora (»url«). Ta korak je obvezen. Strežnik nato shrani datoteke: medtem ima »status« vrednost »finalizing«. Prenos, ki je v celoti prejet, a nikoli zaključen, se samodejno zaključi po 30 minutah nedejavnosti.

curl -X POST https://misi.link/api/upload/complete -H "Content-Type: application/json" \
  -d '{"id": "aB3dE5fG", "token": "…"}'

Neposredno nalaganje v shrambo (priporočeno za velike datoteke)

Z »direct«: true vaš program pošlje datoteko neposredno v shrambo misi.link, mimo strežnika: največja hitrost in na koncu objava v nekaj sekundah. Ena datoteka na prenos (več: združite jih v arhiv). Brez te možnosti ali če odgovor vsebuje »direct«: null, naložite dele s »chunk« kot zgoraj.

  1. Ustvarite prenos z »direct«: true. Odgovor navede »direct.part_size« (velikost vsakega dela, zadnji je krajši), »direct.parts« (število delov) in »direct.sign«.
  2. Pri »sign« zahtevajte podpisane naslove (identifikator, žeton in številke delov, največ 100 na klic; veljajo 6 ur), nato vsak del pošljite z navadnim PUT na njegov naslov, brez glave za preverjanje pristnosti. Dele lahko pošiljate vzporedno in jih po napaki pošljete znova.
  3. Zaključite s »complete«. Če kakšen del manjka, je odgovor »incomplete« s seznamom »missing«: te dele pošljite znova in še enkrat pokličite »complete«. Šifriranje od konca do konca: vsak del je zaporedje celih šifriranih segmentov, po vrsti (glejte primer).
curl -X POST https://misi.link/api/v1/transfers -H "Authorization: Bearer $MISILINK_KEY" -H "Content-Type: application/json" \
  -d '{"files": [{"name": "film.mov", "size": 5368709120}], "direct": true}'
# {…, "direct": {"part_size": 16777216, "parts": 320, "total": 5368709120, "sign": "https://misi.link/api/upload/sign"}}

curl -X POST https://misi.link/api/upload/sign -H "Content-Type: application/json" \
  -d '{"id": "aB3dE5fG", "token": "…", "parts": [1, 2, 3]}'
# {"ok": true, "urls": {"1": "https://…", "2": "https://…", "3": "https://…"}}

curl -X PUT -H "Content-Type: application/octet-stream" --data-binary @part-1.bin "https://…"

curl -X POST https://misi.link/api/upload/complete -H "Content-Type: application/json" -d '{"id": "aB3dE5fG", "token": "…"}'
# {"ok": false, "error": "incomplete", "missing": [2]}

Šifriranje od konca do konca (neobvezno)

Vaš program datoteko šifrira pred pošiljanjem: misi.link prejme in shrani le neberljive podatke. Ključ se nikoli ne pošlje strežniku: je v povezavi, za »#«. Prejemnik prenese in dešifrira v brskalniku, na običajni strani.

  1. Naključno ustvarite 16-bajtni ključ in ustvarite prenos z »e2e«: true in eno samo datoteko (njeno nešifrirano velikost v bajtih). Več datotek najprej združite v arhiv.
  2. Šifrirni ključ: HKDF-SHA-256 ključa (sol »misilink-e2e-v1«, info = identifikator prenosa, 16 bajtov), za AES-GCM.
  3. Datoteko razdelite na segmente po 4 MiB (4.194.304 bajtov). Segment št. i: nonce = 4 ničelni bajti, nato i na 8 bajtih (big-endian); povezani podatki = i na 8 bajtih, nato 1 bajt (1 za zadnji segment, sicer 0). Vsak šifriran segment je 16 bajtov daljši: te bajte naložite s »chunk« po vrsti (skupaj »e2e.encrypted_size«) in zaključite s »complete«.
  4. Priporočeno: »e2e_verify« = HKDF-SHA-256 ključa (ista sol, info »misilink-verify«, 32 bajtov) v base64url. misi.link nato zavrne prenos z napačnim ključem, ne da bi kdaj poznal pravega.
  5. Povezava za deljenje: »url« + »#« + ključ v base64url (22 znakov). S prejemniki (»recipients«) dodajte »e2e_key« (ključ): misi.link ga hrani zapečatenega, da ga vstavi v povezave v e-poštnih sporočilih.
curl -X POST https://misi.link/api/v1/transfers \
  -H "Authorization: Bearer $MISILINK_KEY" -H "Content-Type: application/json" \
  -d '{"files": [{"name": "film.mov", "size": 5368709120}], "e2e": true, "e2e_verify": "…"}'
# {"ok": true, "id": "aB3dE5fG", …, "e2e": {"segment": 4194304, "tag": 16, "encrypted_size": 5368729600, "version": 1}}

Celoten primer v Pythonu (knjižnica cryptography):

#!/usr/bin/env python3
# misi.link: end-to-end encrypted upload through the API (Python 3.8+, pip install cryptography)
# The file goes straight to the storage (signed URLs); if direct upload is unavailable, through "chunk".
# Usage: MISILINK_KEY=mlk_... python3 misilink_e2e.py file.mov [https://misi.link]
import base64, json, os, sys, urllib.request
from cryptography.hazmat.primitives.ciphers.aead import AESGCM
from cryptography.hazmat.primitives.hashes import SHA256
from cryptography.hazmat.primitives.kdf.hkdf import HKDF

SEG, SALT = 4 * 1024 * 1024, b'misilink-e2e-v1'
b64 = lambda b: base64.urlsafe_b64encode(b).rstrip(b'=').decode()
hkdf = lambda ikm, info, n: HKDF(SHA256(), n, SALT, info).derive(ikm)


def call(url, body=None, raw=None, headers=None, method=None, auth=True):
    h = dict(headers or {})
    if auth:
        h['Authorization'] = 'Bearer ' + os.environ['MISILINK_KEY']
    data = raw if raw is not None else (json.dumps(body).encode() if body is not None else None)
    if data is not None:
        h.setdefault('Content-Type', 'application/octet-stream' if raw is not None else 'application/json')
    req = urllib.request.Request(url, data=data, headers=h, method=method or ('POST' if data is not None else 'GET'))
    with urllib.request.urlopen(req, timeout=600) as r:
        body = r.read()
        return json.loads(body) if body[:1] == b'{' else {}


def segments(path, key, size):
    n = max(1, -(-size // SEG))
    with open(path, 'rb') as f:
        for i in range(n):
            last = i == n - 1
            nonce = bytes(4) + i.to_bytes(8, 'big')
            aad = i.to_bytes(8, 'big') + (b'\x01' if last else b'\x00')
            yield key.encrypt(nonce, f.read(SEG), aad)        # SEG bytes in, SEG + 16 bytes out


def send(path, base='https://misi.link'):
    size = os.path.getsize(path)
    secret = os.urandom(16)                                   # the key: never sent to the server
    verify = b64(hkdf(secret, b'misilink-verify', 32))       # lets the server recognise the right key
    t = call(base + '/api/v1/transfers', {'files': [{'name': os.path.basename(path), 'size': size}],
                                         'e2e': True, 'e2e_verify': verify, 'direct': True})
    key = AESGCM(hkdf(secret, t['id'].encode(), 16))
    auth = {'id': t['id'], 'token': t['token']}
    d = t.get('direct')
    if d:                                                     # straight to the storage: parts of d['part_size'] bytes
        part, n, urls = b'', 0, {}
        def put(n, data):
            if str(n) not in urls:
                urls.update(call(d['sign'], {**auth, 'parts': list(range(n, min(n + 100, d['parts'] + 1)))})['urls'])
            call(urls[str(n)], raw=data, method='PUT', auth=False)
        for seg in segments(path, key, size):
            part += seg
            if len(part) == d['part_size']:
                n += 1; put(n, part); part = b''
        if part:
            n += 1; put(n, part)
    else:                                                     # through the server
        sent = 0
        for seg in segments(path, key, size):
            r = call(t['upload']['chunk'] + '?id=' + t['id'] + '&token=' + t['token'] + '&file=' + str(t['files'][0]['id']),
                     raw=seg, headers={'X-Upload-Offset': str(sent)})
            sent = r['received']
    call(t['upload']['complete'], auth)
    return t['url'] + '#' + b64(secret)                      # the key travels after "#", only in the link


if __name__ == '__main__':
    print(send(sys.argv[1], *(sys.argv[2:3] or [])))

Druge zahteve

GET /api/v1/transfers
Vaši prenosi, 50 na stran (?page=2…).
GET /api/v1/transfers/{id}
En prenos: stanje, povezava, datoteke, število prenosov, datum poteka.
DELETE /api/v1/transfers/{id}
Izbris prenosa (povezava preneha delovati).
GET /api/v1/me
Vaš račun, paket in njegove omejitve, velikost delov.

Datumi v obliki ISO 8601 (UTC), velikosti v bajtih.

Odgovori in napake

Vsi odgovori so v obliki JSON z »ok«. Ob napaki: »error« (kratka koda) in »message«. Kode HTTP: 401 ključ manjka ali ni veljaven, 403 paket brez API, 404 ni najdeno, 409 del na napačnem mestu, 422 zahteva zavrnjena, 429 preveč zahtev (počakajte minuto).