API - navodila za razvijalce

Minimax API

Minimax API je RESTful spletna storitev, ki omogoča povezavo z zunanjimi aplikacijami za različne namene uporabe.  Omogoča uporabo določenega omejenega nabora funkcij, ki so vgrajene v programu Minimax.

Tehnična dokumentacija za Minimax API je na voljo na naslednji povezavi: https://moj.minimax.si/SI/API.

Z uporabo API-ja se strinjate z Minimax API pogoji uporabe.

Uporaba API-ja se zaračunava po veljavnem ceniku.

Naslovi

API: https://moj.minimax.si/SI/api/api

AUTH: https://moj.minimax.si/SI/aut/oauth20/token

Novi razvijalci

Če sami razvijate povezavo se po uspešni registraciji v Minimax obrnete na podporo (preko zahtevka po pomoči ali preko elektronske pošte podpora@minimax.si), da pridobite podatke za odjemalca.

Če želite uporabiti katero do obstoječih rešitev, ki so že povezane z Minimaxom (vtičniki za spletne trgovine) ali pa se za implementacijo povezave poslužujete zunanjega razvijalca, ki že dela povezave ta korak ni potreben.

Podatki za prijavo

Za avtentikacijo poleg podatkov odjemalca potrebujete še podatke za prijavo uporabnika.
Prijavite se v SAOP uporabniški račun in v poglavju GESLA ZA DOSTOP ZUNANJIH APLIKACIJ kliknite na gumb NOVA APLIKACIJA. V pojavnem oknu, ki se odpre, vnesite naziv aplikacije, nato pa novo uporabniško ime in geslo s katerim se boste kot uporabnik prijavljali v API.

 

Ureditev nastavitev v programu

V času preizkusnega obdobja so licenca za API in pravice za API avtomatsko vklopljene.

Po prehodu na plačljiv paket pa je potrebno le te izbrati ustrezno licenco in dodati pravice na uporabniku.

Primer

Za avtentikacijo se uporablja protokol OAuth2 (članek OAuth 2 Simplified).

Najprej se prijavite v AUT s podatki odjemalca (id-jem odjemalca in geslom odjemalca) in z uporabniškim imenom in geslom, ki ste ga naredili v SAOP uporabniškem računu (glej Avtentikacija uporabnika), da dobite žeton (token). Pridobljeni žeton posredujete pri vsakem klicu metode API.

Primer v PHPju:

<?php

$params = array(
    'client_id'        => 'ClientId',
    'client_secret'    => 'ClientPassword',
    'grant_type'       => 'password',
    'username'         => 'UserName',
    'password'         => 'UserPassword',
    'scope' => 'minimax.si'
);

$request = array(
    'http' => array(
        'method'        => 'POST',
        'header'        => array(
            'Content-type: application/x-www-form-urlencoded',
        ),
        'content'        => http_build_query($params),
        'timeout'        => 10,
    )
);
if (!$response = file_get_contents('https://moj.minimax.si/SI/aut/oauth20/token', false, stream_context_create($request))) {
    die('auth error');
}
$token = json_decode($response);

$request = array(
    'http' => array(
        'method'        => 'GET',
        'header'        => 'Authorization: Bearer ' . $token->access_token,
        'timeout'        => 10,
    )
);
if (!$response = file_get_contents('https://moj.minimax.si/SI/api/api/currentuser/orgs', false, stream_context_create($request))) {
    die('orgs error');
}
$orgs = json_decode($response, true);
print_r($orgs);