Misi.Link

Документация на API

Изпращайте файлове от собствените си инструменти (скриптове, програми, сървъри): създайте трансфер, качете файловете на части, получете връзката.

Ключ е достъпен с плановете Pro и Business, в Моят профил › API. Цени

Удостоверяване

Създайте ключ в Моят профил › API и го изпращайте в заглавката Authorization на всяка заявка. Пазете го в тайна: дава достъп до вашите трансфери. Изтритият ключ спира да работи веднага.

Authorization: Bearer mlk_…

Ако вашият инструмент или хостинг не предава заглавката Authorization, изпратете същия ключ в заглавката X-API-Key:

X-API-Key: mlk_…

120 заявки в минута на ключ. Размер, брой файлове и срок на наличност: според вашия план.

Изпращане на файлове в три стъпки

1. Създайте трансфера

Посочете списъка с файлове (име и размер в байтове). С „recipients“ всеки получател получава имейл; без получатели получавате връзка за споделяне. По избор: „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. Качете файловете

Изпращайте всеки файл на части от най-много „chunk_size“ байта, поред: „offset“ е броят вече получени байтове от този файл. След прекъсване „status“ показва откъде да продължите (отговор 409: продължете от „received“). Ако хостингът или защитната ви стена филтрира адресите, изпращайте позицията в заглавката X-Upload-Offset вместо в адреса.

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. Завършете

Когато всички файлове са получени, завършете: трансферът става достъпен и имейлите се изпращат. Връзката е тази от първия отговор („url“). Тази стъпка е задължителна. След това сървърът съхранява файловете: междувременно „status“ е „finalizing“. Трансфер, получен изцяло, но незавършен, се завършва автоматично след 30 минути без активност.

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

Директно качване в хранилището (препоръчва се за големи файлове)

С „direct“: true вашата програма изпраща файла директно в хранилището на misi.link, без да минава през сървъра: максимална скорост и достъпен за секунди накрая. Един файл на трансфер (няколко: съберете ги в архив). Без тази опция или ако отговорът съдържа „direct“: null, качете частите с „chunk“ както по-горе.

  1. Създайте трансфера с „direct“: true. Отговорът съдържа „direct.part_size“ (размер на всяка част, последната е по-къса), „direct.parts“ (брой части) и „direct.sign“.
  2. Поискайте подписаните адреси от „sign“ (идентификатор, токен и номера на части, най-много 100 на заявка; валидни 6 часа), после изпратете всяка част с обикновен PUT на нейния адрес, без заглавка за удостоверяване. Частите може да се изпращат паралелно и повторно при грешка.
  3. Завършете с „complete“. Ако липсва част, отговорът е „incomplete“ със списъка „missing“: изпратете тези части отново и извикайте „complete“ пак. Криптиране от край до край: всяка част е поредица от цели криптирани сегменти, поред (вижте примера).
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]}

Криптиране от край до край (по желание)

Вашата програма криптира файла преди изпращане: misi.link получава и съхранява само нечетими данни. Ключът никога не се изпраща на сървъра: той е във връзката, след „#“. Получателят изтегля и декриптира в браузъра си, на обичайната страница.

  1. Генерирайте произволен ключ от 16 байта и създайте трансфера с „e2e“: true и един-единствен файл (некриптираният му размер в байтове). За няколко файла първо ги съберете в архив.
  2. Ключ за криптиране: HKDF-SHA-256 на ключа (сол „misilink-e2e-v1“, info = идентификатор на трансфера, 16 байта), за AES-GCM.
  3. Разделете файла на сегменти от 4 MiB (4 194 304 байта). Сегмент № i: nonce = 4 нулеви байта, после i в 8 байта (big-endian); свързани данни = i в 8 байта, после 1 байт (1 за последния сегмент, иначе 0). Всеки криптиран сегмент е с 16 байта по-дълъг: качете тези байтове с „chunk“, поред (общо „e2e.encrypted_size“), и завършете с „complete“.
  4. Препоръчително: „e2e_verify“ = HKDF-SHA-256 на ключа (същата сол, info „misilink-verify“, 32 байта) в base64url. Тогава misi.link отказва изтегляне с грешен ключ, без изобщо да знае верния.
  5. Връзка за споделяне: „url“ + „#“ + ключът в base64url (22 знака). С получатели („recipients“) добавете „e2e_key“ (ключа): misi.link го пази запечатан, за да го вмъкне във връзките в имейлите.
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}}

Пълен пример на Python (библиотека 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 [])))

Други заявки

GET /api/v1/transfers
Вашите трансфери, по 50 на страница (?page=2…).
GET /api/v1/transfers/{id}
Един трансфер: състояние, връзка, файлове, брой изтегляния, дата на изтичане.
DELETE /api/v1/transfers/{id}
Изтриване на трансфер (връзката спира да работи).
GET /api/v1/me
Вашият профил, планът и неговите ограничения, размер на частите.

Дати във формат ISO 8601 (UTC), размери в байтове.

Отговори и грешки

Всички отговори са в JSON, с „ok“. При грешка: „error“ (кратък код) и „message“. HTTP кодове: 401 липсващ или невалиден ключ, 403 план без API, 404 не е намерено, 409 част на грешно място, 422 отхвърлена заявка, 429 твърде много заявки (изчакайте минута).