API
Kuidas lisada organisatsiooni liikmete nimekiri oma organisatsiooni lehele?
Minimaalselt lisa oma veebilehe <head> sektsiooni järgmine kood:
<script src="https://constellations.belong-events.com/api/lib/belong.v1.js" id="belong-events-api" defer>
</script>
<script defer>
const conf = {
organizationId: 7048,
};
document.addEventListener('DOMContentLoaded', function () {
window.belong.organizationMembers(conf);
});
</script>
Seda saab kasutada näiteks Google Sites'i manustes või paljudes teistes veebimootorites.
Konfiguratsioon
Ülaltoodud koodis kasutatakse ühte kohustuslikku konfiguratsiooniparameetrit - organizationId, mis tuleb asendada sinu organisatsiooni ID-ga.
Alljärgnev on kõigi parameetrite täielik loetelu:
organizationId
Andmetüüp: täisarv. Positiivne.
Kohustuslik.
Kirjeldus: organisatsiooni identifikaator, mille liikmeid näidatakse. Selle võib leida organisatsiooni veebiaadressist. Näiteks kui aadress on
https://constellations.belong-events.com/et/organization/7062/my-organization
siis 7062 on organizationId
organizationMembersElementId
Andmetüüp: string. CSS elemendi ID.
Valikuline.
Vaikeväärtus: organization-members
Kirjeldus: Eeldatakse, et lehel on järgmine element, mis täidetakse nimekirjaga:
<div id="organization-members"></div>
Kui ID on erinev, tuleks see määrata selle konfiguratsiooniparameetri abil.
styling
Andmetüüp: string. Võimalikud väärtused: default või custom.
Valikuline.
Vaikeväärtus: default
Kirjeldus: default väärtus laadib vaikestiilid, mis võimaldavad kiireid tulemusi ilma tehniliste stiilide üksikasjadesse süvenemata. custom väärtus väldib vaikestiili laadimist ja eeldab, et kohandatud stiilid on juba olemas. Originaalstiililehte saab kopeerida ja hakata kohandama.
template
Andmetüüp: string. HTML kood koos mallimuutujatega.
Valikuline.
Vaikeväärtus:
<a class="organization-member" href="{{url}}">
<div class="image" style="background-image: url('{{image}}');"></div>
<div class="name">{{name}}</div>
</a>
Kirjeldus: See on mall, mille alusel iga kirje genereeritakse. Kõik loodud kirjed sisestatakse organization-members elementi. Kohatäited on topelt looksulgude vahel {{...}}. Selles elemendis saab kasutada järgmisi kohatäiteid:
url - isiku lehe URL
image - pildi URL
name - isiku nimi
email - isiku email
phone - isiku telefon
debug
Andmetüüp: boolean.
Valikuline.
Vaikimisi: false
Kui väärtus on true, siis väljastatakse kogu konfiguratsioon JS konsooli.
API lõpp-punkt
API lõpp-punkti URL on järgmine:
https://constellations.belong-events.com/api/v1/organization/{{organizationId}}/members
{{OrganizationId}} tuleb asendada vastava numbriga, mille leiab organisatsiooni URL-ist.
API vastus on avalike liikmete nimekiri JSON formaadis. Näiteks:
{
"status": "ok",
"data": [
{
"id": 6964,
"name": "John Doe",
"image": "https://constellations.belong-events.com/sites/default/files/styles/id_image/public/person/6964-3b8cc9371cd708aa82b648af7bb7e101.jpg?itok=Lw9WazNJ",
"email": "john@example.com",
"phone": "(+1) 123 123 123",
"url": "https://constellations.belong-events.com/person/6964/john-doe"
},
{
"id": 6959,
"name": "Jane Smith",
"image": "https://constellations.belong-events.com/sites/default/files/styles/id_image/public/person/6959-3ed190bcaeba32d27839b9ac074c8962.jpg?itok=z8Jl4u8a",
"email": "jane@example.com",
"phone": "(+1) 123 123 123",
"url": "https://constellations.belong-events.com/person/6959/jane-smith"
}
]
}
Kui päring õnnestus, siis on status väärtuseks ok, vastasel juhul aga error. Viimasel juhul on olemas error väli, mis sisaldab vea kirjeldust. Mõned väljad võivad puududa, näiteks email, telefon või pildi URL, kui neid kasutaja poolt ei määratud.
Versioonihaldus
API lõpp-punktid
https://constellations.belong-events.com/api/v1/organization/{{organizationId}}/members
Versioon kuulub domeenile (antud juhul organisatsioonile), mis järgib versiooninumbrit. Igal API domeenil võib olla erinev versiooninumber. Numbrid suurenevad siis, kui on tegemist tagurpidi ühildumatute muudatustega. Uute väljade lisamisel versiooni ei muudeta.
Library
Kui mõne API domeeni versioon suureneb, muutub kättesaadavaks uus library versioon. See tähendab, et võib tekkida teatav ühildamatus.