Misi.Link

API-dokumentaatio

Lähetä tiedostoja omista työkaluistasi (skriptit, ohjelmat, palvelimet): luo siirto, lataa tiedostot osina, saat linkin.

Avaimet ovat käytettävissä Pro- ja Yritys-tilauksissa kohdassa Oma tili › API. Hinnat

Tunnistautuminen

Luo avain kohdassa Oma tili › API ja lähetä se jokaisen pyynnön Authorization-otsakkeessa. Pidä se salassa: se antaa pääsyn siirtoihisi. Poistettu avain lakkaa toimimasta heti.

Authorization: Bearer mlk_…

Jos työkalusi tai palvelimesi ei välitä Authorization-otsaketta, lähetä sama avain X-API-Key-otsakkeessa:

X-API-Key: mlk_…

120 pyyntöä minuutissa avainta kohden. Koko, tiedostojen määrä ja saatavuusaika: tilauksesi mukaan.

Lähetä tiedostot kolmessa vaiheessa

1. Luo siirto

Anna tiedostoluettelo (nimi ja koko tavuina). Kun annat ”recipients”-kentän, jokainen vastaanottaja saa sähköpostin; ilman vastaanottajia saat jaettavan linkin. Valinnaiset: ”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. Lataa tiedostot

Lähetä jokainen tiedosto enintään ”chunk_size” tavun osina järjestyksessä: ”offset” on tiedostosta jo vastaanotettujen tavujen määrä. Katkoksen jälkeen ”status” kertoo, mistä jatkaa (vastaus 409: jatka kohdasta ”received”). Jos palveluntarjoajasi tai palomuurisi suodattaa osoitteita, lähetä sijainti X-Upload-Offset-otsakkeessa osoitteen sijaan.

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. Viimeistele

Kun kaikki tiedostot on vastaanotettu, viimeistele: siirto julkaistaan ja sähköpostit lähtevät. Linkki on ensimmäisen vastauksen ”url”. Tämä vaihe on pakollinen. Palvelin tallentaa sitten tiedostot: sillä aikaa ”status” on ”finalizing”. Kokonaan vastaanotettu mutta viimeistelemätön siirto viimeistellään automaattisesti 30 minuutin toimettomuuden jälkeen.

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

Suora lähetys tallennustilaan (suositellaan suurille tiedostoille)

Asetuksella ”direct”: true ohjelmasi lähettää tiedoston suoraan misi.linkin tallennustilaan palvelimen ohi: suurin nopeus, ja lopuksi tiedosto on saatavilla sekunneissa. Yksi tiedosto siirtoa kohden (useampi: kokoa ne arkistoon). Ilman tätä asetusta, tai jos vastauksessa on ”direct”: null, lähetä osat ”chunk”-kutsulla kuten yllä.

  1. Luo siirto arvolla ”direct”: true. Vastaus kertoo ”direct.part_size” (kunkin osan koko, viimeinen on lyhyempi), ”direct.parts” (osien määrä) ja ”direct.sign”.
  2. Pyydä allekirjoitetut osoitteet ”sign”-kutsulla (tunniste, tunnus ja osien numerot, enintään 100 kutsua kohden; voimassa 6 tuntia) ja lähetä jokainen osa tavallisella PUT-pyynnöllä sen osoitteeseen ilman todennusotsaketta. Osat voi lähettää rinnakkain ja uudelleen virheen jälkeen.
  3. Viimeistele ”complete”-kutsulla. Jos osa puuttuu, vastaus on ”incomplete” ja luettelo ”missing”: lähetä nämä osat uudelleen ja kutsu ”complete” uudestaan. Päästä päähän -salaus: jokainen osa on jono kokonaisia salattuja jaksoja järjestyksessä (katso esimerkki).
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]}

Päästä päähän -salaus (valinnainen)

Ohjelmasi salaa tiedoston ennen lähetystä: misi.link vastaanottaa ja tallentaa vain lukukelvotonta dataa. Avainta ei koskaan lähetetä palvelimelle: se on linkissä ”#”-merkin jälkeen. Vastaanottaja lataa ja purkaa salauksen selaimessaan tavallisella sivulla.

  1. Luo satunnainen 16 tavun avain ja luo siirto arvolla ”e2e”: true ja yhdellä tiedostolla (sen salaamaton koko tavuina). Useammat tiedostot kokoa ensin arkistoon.
  2. Salausavain: avaimen HKDF-SHA-256 (suola ”misilink-e2e-v1”, info = siirron tunniste, 16 tavua), AES-GCM:ää varten.
  3. Jaa tiedosto 4 MiB:n (4 194 304 tavun) osiin. Osa nro i: nonce = 4 nollatavua ja sitten i 8 tavuna (big-endian); liitetty data = i 8 tavuna ja sitten 1 tavu (viimeisessä osassa 1, muuten 0). Jokainen salattu osa on 16 tavua pidempi: lähetä nämä tavut ”chunk”-kutsulla järjestyksessä (yhteensä ”e2e.encrypted_size”) ja viimeistele ”complete”-kutsulla.
  4. Suositeltu: ”e2e_verify” = avaimen HKDF-SHA-256 (sama suola, info ”misilink-verify”, 32 tavua) base64url-muodossa. misi.link hylkää silloin latauksen väärällä avaimella tuntematta koskaan oikeaa.
  5. Jaettava linkki: ”url” + ”#” + avain base64url-muodossa (22 merkkiä). Vastaanottajien (”recipients”) kanssa lisää ”e2e_key” (avain): misi.link säilyttää sen sinetöitynä lisätäkseen sen sähköpostien linkkeihin.
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}}

Täydellinen esimerkki Pythonilla (cryptography-kirjasto):

#!/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 [])))

Muut pyynnöt

GET /api/v1/transfers
Siirtosi, 50 sivua kohden (?page=2…).
GET /api/v1/transfers/{id}
Yksi siirto: tila, linkki, tiedostot, latausten määrä, vanhenemispäivä.
DELETE /api/v1/transfers/{id}
Poista siirto (linkki lakkaa toimimasta).
GET /api/v1/me
Tilisi, tilauksesi ja sen rajat, osien koko.

Päivämäärät ISO 8601 -muodossa (UTC), koot tavuina.

Vastaukset ja virheet

Kaikki vastaukset ovat JSONia, ja niissä on ”ok”. Virhetilanteessa: ”error” (lyhyt koodi) ja ”message”. HTTP-koodit: 401 avain puuttuu tai on virheellinen, 403 tilaus ilman APIa, 404 ei löydy, 409 osa väärässä kohdassa, 422 pyyntö hylätty, 429 liikaa pyyntöjä (odota minuutti).