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 МіБ (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 забагато запитів (зачекайте хвилину).