Mokapen API dokumentacija

Pregled

Mokapen API-ji su REST. Svaki zahtjev mora sadržavati valjano zaglavlje Authorization: Bearer , osim ako nije drugačije navedeno.

Osnovni URL: https://mokapen.com/api

Prefiks verzije API-ja: v1 (primjer: /api/v1/{org_id}/contacts).

Korak 1 — Izradite aplikaciju

Prijavite se na Mokapen, otvorite svoju organizaciju i idite na Account → Developer → My Applications. Odatle možete vidjeti postojeće aplikacije ili izraditi novu.

Mokapen podržava dvije vrste aplikacija:

• App public — dizajniran za integracije koje koristi više korisnika Mokapena. Upotrijebite tok autorizacijskog koda OAuth 2.0. Korisnici autoriziraju vašu aplikaciju i odabiru kojoj će organizaciji odobriti pristup.
• Privatne aplikacije — dizajnirane za internu automatizaciju unutar vaše organizacije. Koristite odobrenje client_credentials. Tokeni se generiraju s nadzorne ploče razvojnog programera bez OAuth preusmjeravanja na krajnjeg korisnika.

Zahtjevi za prijavu

Korak 2 — Odaberite opsege API-ja

Nakon popunjavanja podataka aplikacije, kliknite Nastavi za odabir potrebnih opsega (dozvola), a zatim spremite aplikaciju.

Samo opsege omogućene tijekom postavljanja moguće je zatražiti u autorizaciji (javna aplikacija) ili uključiti u tokene (privatna aplikacija).

Korak 3 — Aktivacija i vjerodajnice

privatne aplikacije aktiviraju se odmah nakon izrade. Vlasnici i administratori organizacije mogu ih deaktivirati ili ponovno aktivirati u bilo kojem trenutku na stranici aplikacije.

javne aplikacije počinju kao Pending Approval. Mokapen pregledava potrebne opsege prije aktivacije aplikacije. Kada je status Active, otvorite karticu Credentials da biste dobili client_id i client_secret i pokrenuli tok OAuth autorizacijskog koda.

Ako promijenite opsege na već aktivnoj javnoj aplikaciji, ona se vraća na čekanje odobrenja, a postojeći tokeni se opozivaju.

Pohranite svoje vjerodajnice na sigurno. Nikada ne otkrivajte klijentsku tajnu u kodu na strani klijenta ili u javnim spremištima.

Sljedeći koraci

• Javna aplikacija → slijedite Vodič za autentifikaciju (OAuth autorizacijski kod).
• Privatne aplikacije → generirajte token na kartici Vjerodajnice, zatim pogledajte Tokeni privatnih aplikacija.
• Istražite krajnje točke u API Reference.