Oficialaj SDK-oj de Militant

La oficialaj SDK-oj ebligas rapide integri la API de Militant en Python kaj JavaScript/Node.js projektoj.

Por kio ili utilas

• rapide lancci bot-on, laborprocezon au automatigan skripton
• konekti Militant al Python, Node.js au React Native apliko
• uzi la finpunktojn sen rekrei la tutan HTTP- kaj autentikigan tavolon
• konstrui administrajn, moderigajn au eksportajn ilojn

Disponegaj SDK-oj

Python SDK

• Dosiero: militant.py
• Dokumentaro: Python README en GitLab
• Dependecoj: requests
• Uzo: skriptoj, botoj, Python backend-aplikoj

JavaScript SDK

• Dosiero: militant.js
• Dokumentaro: JavaScript README en GitLab
• Dependecoj: axios
• Uzo: Node.js, retaj aplikoj, React Native

Botoj kaj automatigo

• Inkludita ekzemplo: Keyword Relay Bot
• Vojo: examples/bots/keyword-relay-bot
• Uzoj: temo-gvatado, atentigo-relajso, malpeza moderado, operatora konta laborfluo

Rapida instalado

Python

mkdir -p vendor/militant-sdk
curl -fsSLo vendor/militant-sdk/militant.py https://gitlab.com/militant1/militant-api/-/raw/main/sdk/python/militant.py
pip install requests

JavaScript

mkdir -p vendor/militant-sdk
curl -fsSLo vendor/militant-sdk/militant.js https://gitlab.com/militant1/militant-api/-/raw/main/sdk/javascript/militant.js
npm install axios

Rapida integriĝo

Python

import sys
sys.path.append('./vendor/militant-sdk')
from militant import MilitantClient

JavaScript

const MilitantClient = require('./vendor/militant-sdk/militant');

Se vi preferas tre simplan projekto-strukturon, metu militant.py au militant.js rekte en la radikon de via apliko.

Uzekzemplo

Python

from militant import MilitantClient
client = MilitantClient('https://militant.revlibertaire.com')
user = client.login('username', 'password')
timeline = client.get_timeline()
post = client.create_post('Hello from Python!')

JavaScript

const MilitantClient = require('./militant');
(async () => {
  const client = new MilitantClient('https://militant.revlibertaire.com');
  const user = await client.login('username', 'password');
  const timeline = await client.getTimeline();
  const post = await client.createPost('Hello from JavaScript!');
})();

Kovritaj funkcioj

La du SDK-oj kovras grandan parton de la API kaj servas kiel la ĉefa integriĝa tavolo por oftaj uzoj:

Aŭtentikigo

• ensaluto/elensaluto per JWT-ĵetono
• refreŝigo de ĵetono
• nuligo de ĵetono

Socia enhavo

• afiŝoj, komentoj kaj reagoj
• ŝatoj, kundividoj kaj legosignoj
• rakontoj
• plurlingva traduko

Uzantoj kaj rilatoj

• uzantaj profiloj
• sekvantoj kaj sekvatoj
• amikpetoj
• privataj mesaĝoj
• mesaĝgrupoj

Grupoj kaj paĝoj

• kreado kaj administrado de grupoj
• grupaj afiŝoj kaj komentoj
• kreado kaj administrado de paĝoj
• paĝaj afiŝoj

Amaskomunikiloj kaj eventoj

• alŝuto de dosieroj
• fotoalbumoj
• vivaj elsendoj
• eventoj

Moderado kaj sekureco

• raportoj
• moderigantaj voĉdonoj
• sankcioj
• 2FA
• uzantaj preferoj
• eksporto de datumoj

Aŭdaj kaj video-vokoj (nur Flutter)

• unu-al-unu aŭdaj/video-vokoj
• grupaj vokoj
• WebRTC signalado tra la API
• ICE restart por reta movebleco
• Noto: postulas la kaplinion X-Flutter-App: militant-flutter-v1

Noto:

• kelkaj tre lastatempaj finpunktoj povas aperi en la API antaŭ ol ambaŭ SDK-oj subtenas ilin
• tial oni rigardu ĉi tiujn SDK-ojn kiel la ĉefan integriĝan tavolon, sed ne kiel 100% tujan kovron

Detala dokumentaro

• Python dokumentaro - plena gvidilo kun Python-ekzemploj
• JavaScript dokumentaro - plena gvidilo kun JavaScript-ekzemploj
• API-finpunktoj - listo de ĉiuj disponeblaj finpunktoj

Sekureco

• ĉiuj alvokoj uzu HTTPS
• aŭtentikigo per JWT-ĵetono
• aŭtomata rapidec-limigo
• subteno por 2FA
• sekura traktado de ĵetonoj

Plurlingva subteno

La API kaj la SDK-oj subtenas:

• Francan
• Anglan
• Hispanan
• Esperanton

Tipaj uzkazoj

Moderiga boto

client = MilitantClient('https://militant.revlibertaire.com')
client.login('bot_username', 'bot_password')
reports = client.get_reports()
for report in reports['data']:
    if report['reason'] == 'spam':
        client.vote_on_report(report['id'], 'approve')

Reta apliko

const client = new MilitantClient('https://militant.revlibertaire.com');
await client.login(username, password);
const timeline = await client.getTimeline(1, 20);
displayPosts(timeline.posts);

Eksporta skripto

client = MilitantClient('https://militant.revlibertaire.com')
client.login('username', 'password')
data = client.export_data()

Raporti cimon

Malfermu issue en GitLab:

• militant-api

Kontribuo

Kontribuoj bonvenas: 1. Forku la projekton en GitLab 2. Kreu funkciobranĉon 3. Commit viajn ŝanĝojn 4. Puŝu la branĉon 5. Malfermu merge request

Permesilo

La SDK-oj estas distribuataj sub la sama permesilo kiel la API de Militant. Vidu LICENSE en la radiko de la projekto.

Utilaj ligiloj

• Hejmo de la vikio
• API-instalado
• Unua API-voko
• Listo de finpunktoj
• Oftaj demandoj

---