Misi.Link

Dokumentácia API

Odosielajte súbory z vlastných nástrojov (skripty, programy, servery): vytvorte prenos, nahrajte súbory po častiach, získajte odkaz.

Kľúč je dostupný v tarifoch Pro a Business v časti Môj účet › API. Cenník

Overenie

Vytvorte kľúč v časti Môj účet › API a posielajte ho v hlavičke Authorization každej požiadavky. Uchovajte ho v tajnosti: dáva prístup k vašim prenosom. Odstránený kľúč okamžite prestane fungovať.

Authorization: Bearer mlk_…

Ak váš nástroj alebo hosting neodovzdáva hlavičku Authorization, pošlite rovnaký kľúč v hlavičke X-API-Key:

X-API-Key: mlk_…

120 požiadaviek za minútu na kľúč. Veľkosť, počet súborov a doba dostupnosti: podľa vášho tarifu.

Odoslanie súborov v troch krokoch

1. Vytvorenie prenosu

Uveďte zoznam súborov (názov a veľkosť v bajtoch). S položkou „recipients“ dostane každý príjemca e-mail; bez príjemcov získate odkaz na zdieľanie. Voliteľne: „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. Nahranie súborov

Posielajte každý súbor po častiach s veľkosťou najviac „chunk_size“ bajtov, postupne: „offset“ je počet už prijatých bajtov daného súboru. Po prerušení „status“ ukáže, kde pokračovať (odpoveď 409: pokračujte od „received“). Ak váš hosting alebo firewall filtruje adresy, posielajte pozíciu v hlavičke X-Upload-Offset namiesto 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čenie

Keď sú prijaté všetky súbory, prenos dokončite: zverejní sa a odídu e-maily. Odkaz je ten z prvej odpovede („url“). Tento krok je povinný. Server potom súbory uloží: medzitým má „status“ hodnotu „finalizing“. Prenos prijatý celý, ale nikdy nedokončený, sa dokončí automaticky po 30 minútach nečinnosti.

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

Priame nahratie do úložiska (odporúčané pre veľké súbory)

S „direct“: true váš program posiela súbor priamo do úložiska misi.link, bez prechodu cez server: maximálna rýchlosť a na konci online za pár sekúnd. Jeden súbor na prenos (viac súborov: spojte ich do archívu). Bez tejto voľby, alebo ak odpoveď obsahuje „direct“: null, nahrávajte časti cez „chunk“ ako vyššie.

  1. Vytvorte prenos s „direct“: true. Odpoveď uvádza „direct.part_size“ (veľkosť každej časti, posledná je kratšia), „direct.parts“ (počet častí) a „direct.sign“.
  2. Vyžiadajte si podpísané adresy cez „sign“ (identifikátor, token a čísla častí, najviac 100 na volanie; platné 6 hodín) a pošlite každú časť obyčajným PUT na jej adresu, bez autentifikačnej hlavičky. Časti možno posielať súbežne a po chybe znova.
  3. Dokončite cez „complete“. Ak časť chýba, odpoveď je „incomplete“ so zoznamom „missing“: pošlite tieto časti znova a zavolajte „complete“ ešte raz. Šifrovanie end-to-end: každá časť je rad celých zašifrovaných segmentov, postupne (pozri prí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]}

Šifrovanie end-to-end (voliteľné)

Váš program súbor pred odoslaním zašifruje: misi.link prijíma a ukladá len nečitateľné údaje. Kľúč sa nikdy neposiela na server: je v odkaze, za „#“. Príjemca sťahuje a dešifruje vo svojom prehliadači, na obvyklej stránke.

  1. Vygenerujte náhodný kľúč so 16 bajtmi a vytvorte prenos s „e2e“: true a jediným súborom (jeho nešifrovaná veľkosť v bajtoch). Viac súborov najprv spojte do archívu.
  2. Šifrovací kľúč: HKDF-SHA-256 kľúča (soľ „misilink-e2e-v1“, info = identifikátor prenosu, 16 bajtov), pre AES-GCM.
  3. Rozdeľte súbor na segmenty po 4 MiB (4 194 304 bajtov). Segment č. i: nonce = 4 nulové bajty a potom i na 8 bajtoch (big-endian); pridružené údaje = i na 8 bajtoch a potom 1 bajt (1 pre posledný segment, inak 0). Každý zašifrovaný segment je o 16 bajtov dlhší: nahrajte tieto bajty cez „chunk“ postupne („e2e.encrypted_size“ spolu) a dokončite cez „complete“.
  4. Odporúčané: „e2e_verify“ = HKDF-SHA-256 kľúča (rovnaká soľ, info „misilink-verify“, 32 bajtov) v base64url. misi.link potom odmietne stiahnutie so zlým kľúčom bez toho, aby kedy poznal ten správny.
  5. Odkaz na zdieľanie: „url“ + „#“ + kľúč v base64url (22 znakov). S príjemcami („recipients“) pridajte „e2e_key“ (kľúč): misi.link ho uchová zapečatený, aby ho vložil do odkazov v e-mailoch.
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ý príklad v Pythone (kniž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 [])))

Ďalšie požiadavky

GET /api/v1/transfers
Vaše prenosy, 50 na stránku (?page=2…).
GET /api/v1/transfers/{id}
Jeden prenos: stav, odkaz, súbory, počet stiahnutí, dátum vypršania.
DELETE /api/v1/transfers/{id}
Odstránenie prenosu (odkaz prestane fungovať).
GET /api/v1/me
Váš účet, tarif a jeho limity, veľkosť častí.

Dátumy vo formáte ISO 8601 (UTC), veľkosti v bajtoch.

Odpovede a chyby

Všetky odpovede sú vo formáte JSON s položkou „ok“. Pri chybe: „error“ (krátky kód) a „message“. Kódy HTTP: 401 chýbajúci alebo neplatný kľúč, 403 tarif bez API, 404 nenájdené, 409 časť na nesprávnom mieste, 422 požiadavka zamietnutá, 429 priveľa požiadaviek (počkajte minútu).