Mokapen API dokumentácia

Token nositeľa hlavičky

Zahrňte prístupový token do každej požiadavky API:

Oprávnenie: Nositeľ eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9...
Prijať: application/json

Verejná aplikácia — autorizačný kód OAuth 2.0

Verejné aplikácie používajú štandardné udelenie autorizačného kódu OAuth 2.0.

Žiadosť o autorizáciu

Presmerujte používateľa na koncový bod autorizácie:

ZÍSKAJTE https://mokapen.com/oauth/authorize

Parametre dopytu:
  client_id (povinné) Vaše ID klienta
  redirect_uri (povinné) Musí sa zhodovať s registrovanou adresou URL presmerovania
  response_type (povinné) Musí byť "code"
  rozsah (povinné) Rozsahy oddelené medzerou, napr. úlohy.čítať úlohy.písať
  stav (povinné) Náhodná hodnota (min. 16 znakov) anti-CSRF

Príklad žiadosti o autorizáciu (PHP)

$params = [
    'client_id' => 'YOUR_CLIENT_ID',
    'redirect_uri' => 'https://example.com/oauth/callback',
    'response_type' => 'kód',
    'scope' => 'tasks.read tasks.write',
    'state' => bin2hex(random_bytes(8)),
];

$url = 'https://mokapen.com/oauth/authorize?' . http_build_query($params);
header('Umiestnenie: ' . $url);

Vymeňte autorizačný kód za tokeny

Po schválení sa Mokapen presmeruje na váš redirect_uri s parametrom code. Vymeňte ho za žetóny:

POST https://mokapen.com/oauth/token
Content-Type: application/x-www-form-urlencoded

grant_type=autorizačný_kód
&client_id=ID_VÁŠHO_KLIENTA
&client_secret=VÁŠ_KLIENT_TAJOM
&redirect_uri=https://example.com/oauth/spätné volanie
&code=AUTHORIZATION_CODE_FROM_CALLBACK

Príklad odpovede tokenu

{
  "token_type": "Nositeľ",
  "expires_in": 31536000,
  "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9...",
  "refresh_token": "def50200...",
  "id_organizácie": 849,
  "organization_name": "Vaša organizácia"
}

Obnoviť token

Keď platnosť prístupového tokenu vyprší, požiadajte o nový s obnovovacím tokenom:

POST https://mokapen.com/oauth/token
Content-Type: application/x-www-form-urlencoded

grant_type=refresh_token
&client_id=ID_VÁŠHO_KLIENTA
&client_secret=VÁŠ_KLIENT_TAJOM
&refresh_token=VÁŠ_REFRESH_TOKEN

Súkromné ​​aplikácie – prihlasovacie údaje klienta

Súkromné ​​aplikácie nevyžadujú presmerovania OAuth. Na paneli vývojára otvorte aplikáciu, prejdite na Credentials a kliknite na Generate Token.

Token je vytvorený s grantom client_credentials a je prepojený s organizáciou aktívnou v relácii. Uchovávajte ho bezpečne a nezdieľajte ho verejne.

POST https://mokapen.com/oauth/token
Content-Type: application/x-www-form-urlencoded

grant_type=client_credentials
&client_id=ID_VÁŠHO_KLIENTA
&client_secret=VÁŠ_KLIENT_TAJOM
&scope=tasks.read tasks.write contacts.read
&organization_id=849

Prvá požiadavka API

$url = 'https://mokapen.com/api/v1/849/contacts';
$token = 'VÁŠ_PRÍSTUP_TOKEN';

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => pravda,
    CURLOPT_HTTPHEADER => [
        „Oprávnenie: Nositeľ“ . $token,
        'Prijať: application/json',
    ],
]);
$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);