Misi.Link

Dokumentace API

Odesílejte soubory z vlastních nástrojů (skripty, programy, servery): vytvořte přenos, nahrajte soubory po částech, získejte odkaz.

Klíč je k dispozici v tarifech Pro a Business v sekci Můj účet › API. Ceník

Ověření

Vytvořte klíč v sekci Můj účet › API a posílejte ho v hlavičce Authorization každého požadavku. Uchovejte ho v tajnosti: dává přístup k vašim přenosům. Smazaný klíč okamžitě přestane fungovat.

Authorization: Bearer mlk_…

Pokud váš nástroj nebo hosting nepředává hlavičku Authorization, pošlete stejný klíč v hlavičce X-API-Key:

X-API-Key: mlk_…

120 požadavků za minutu na klíč. Velikost, počet souborů a doba dostupnosti: podle vašeho tarifu.

Odeslání souborů ve třech krocích

1. Vytvoření přenosu

Uveďte seznam souborů (název a velikost v bajtech). S položkou „recipients“ dostane každý příjemce e-mail; bez příjemců získáte odkaz ke sdílení. Volitelně: „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. Nahrání souborů

Posílejte každý soubor po částech o velikosti nejvýše „chunk_size“ bajtů, popořadě: „offset“ je počet již přijatých bajtů daného souboru. Po přerušení „status“ ukáže, kde pokračovat (odpověď 409: pokračujte od „received“). Pokud váš hosting nebo firewall filtruje adresy, posílejte pozici v hlavičce X-Upload-Offset místo v adrese.

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. Dokončení

Až budou přijaty všechny soubory, přenos dokončete: zveřejní se a odejdou e-maily. Odkaz je ten z první odpovědi („url“). Tento krok je povinný. Server pak soubory uloží: mezitím má „status“ hodnotu „finalizing“. Přenos přijatý celý, ale nikdy nedokončený, se dokončí automaticky po 30 minutách nečinnosti.

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

Přímé nahrání do úložiště (doporučeno pro velké soubory)

S „direct“: true váš program posílá soubor přímo do úložiště misi.link, bez průchodu serverem: maximální rychlost a na konci online během několika sekund. Jeden soubor na přenos (více souborů: spojte je do archivu). Bez této volby, nebo pokud odpověď obsahuje „direct“: null, nahrávejte části přes „chunk“ jako výše.

  1. Vytvořte přenos s „direct“: true. Odpověď uvádí „direct.part_size“ (velikost každé části, poslední je kratší), „direct.parts“ (počet částí) a „direct.sign“.
  2. Vyžádejte si podepsané adresy u „sign“ (identifikátor, token a čísla částí, nejvýše 100 na volání; platné 6 hodin) a pošlete každou část obyčejným PUT na její adresu, bez autentizační hlavičky. Části lze posílat souběžně a po chybě znovu.
  3. Dokončete přes „complete“. Pokud část chybí, odpověď je „incomplete“ se seznamem „missing“: pošlete tyto části znovu a zavolejte „complete“ ještě jednou. Šifrování end-to-end: každá část je řada celých zašifrovaných segmentů, popořadě (viz příklad).
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]}

Šifrování end-to-end (volitelné)

Váš program soubor před odesláním zašifruje: misi.link přijímá a ukládá jen nečitelná data. Klíč se nikdy neposílá na server: je v odkazu, za „#“. Příjemce stahuje a dešifruje ve svém prohlížeči, na obvyklé stránce.

  1. Vygenerujte náhodný klíč o 16 bajtech a vytvořte přenos s „e2e“: true a jediným souborem (jeho nešifrovaná velikost v bajtech). Více souborů nejprve spojte do archivu.
  2. Šifrovací klíč: HKDF-SHA-256 klíče (sůl „misilink-e2e-v1“, info = identifikátor přenosu, 16 bajtů), pro AES-GCM.
  3. Rozdělte soubor na segmenty po 4 MiB (4 194 304 bajtů). Segment č. i: nonce = 4 nulové bajty a pak i na 8 bajtech (big-endian); přidružená data = i na 8 bajtech a pak 1 bajt (1 pro poslední segment, jinak 0). Každý zašifrovaný segment je o 16 bajtů delší: nahrajte tyto bajty přes „chunk“ popořadě („e2e.encrypted_size“ celkem) a dokončete přes „complete“.
  4. Doporučeno: „e2e_verify“ = HKDF-SHA-256 klíče (stejná sůl, info „misilink-verify“, 32 bajtů) v base64url. misi.link pak odmítne stažení se špatným klíčem, aniž by kdy znal ten správný.
  5. Odkaz ke sdílení: „url“ + „#“ + klíč v base64url (22 znaků). S příjemci („recipients“) přidejte „e2e_key“ (klíč): misi.link ho uchová zapečetěný, aby ho vložil do odkazů v e-mailech.
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}}

Úplný příklad v Pythonu (knihovna 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 [])))

Další požadavky

GET /api/v1/transfers
Vaše přenosy, 50 na stránku (?page=2…).
GET /api/v1/transfers/{id}
Jeden přenos: stav, odkaz, soubory, počet stažení, datum vypršení.
DELETE /api/v1/transfers/{id}
Smazání přenosu (odkaz přestane fungovat).
GET /api/v1/me
Váš účet, tarif a jeho limity, velikost částí.

Data ve formátu ISO 8601 (UTC), velikosti v bajtech.

Odpovědi a chyby

Všechny odpovědi jsou ve formátu JSON s položkou „ok“. Při chybě: „error“ (krátký kód) a „message“. Kódy HTTP: 401 chybějící nebo neplatný klíč, 403 tarif bez API, 404 nenalezeno, 409 část na špatném místě, 422 požadavek odmítnut, 429 příliš mnoho požadavků (počkejte minutu).