Utforsk REST APIs i OpenCart 2.0 Del ett

Du ser mange spennende funksjoner i den siste store versjonen av OpenCart, alt fra fullstendig responsiv design i front-end og back-end til hendelsesvarslingssystemet og mange flere. En av de mektigste blant dem er introduksjonen av REST APIer. 

I denne todelte serien vil vi utforske de fleste av de tilgjengelige APIene og gå gjennom bestillingsprosessen ved å bruke dem. I denne første delen ser vi hvordan du oppretter en API-brukerens legitimasjon og noen av de grunnleggende API-bruken.

REST APIene tillater tredjepartssystemer å samhandle med OpenCart-butikken sømløst. Hva med å plassere ordrer i butikken din ved hjelp av iOS / Android-appen? Faktisk kan du tenke på noe system uansett hvilken teknologi den er bygget på! Integrasjonen er mulig nå med settet av APIer levert av OpenCart 2.0.

I denne delen vil jeg demonstrere bruken av APIer ved hjelp av PHP cURL biblioteket. Så, du trenger PHP cURL biblioteket installert for å kjøre eksemplene. Åpenbart trenger du også den nyeste versjonen av OpenCart, som er 2.0!

Opprett API-brukerhenvisninger

Før vi begynner å bruke APIer, må vi konfigurere "API-brukeren" for det. Uten det kan du ikke få tilgang til det, og du får en tillatelse nektet feil. Så la oss sette opp det. Navigere til System> Brukere> API og det vil liste alle tilgjengelige API-brukere.

Klikk på + knappen øverst til høyre for å legge til en ny API-bruker.

Som du kan se, må du skrive inn Brukernavn, Passord og Status. Du kan også bruke generere knappen for å lage en kompleks passordstreng, som jeg har gjort! Sørg også for at Status er satt til aktivert. Lagre endringene, og du er god til å gå!

Nå som vi har konfigurert API-brukeren, kan vi begynne å utforske APIene!

Konfigurer de vanlige filene

Som vi ser de grunnleggende kjerne-PHP-eksemplene i denne serien, la oss sørge for at vi konfigurerer filen som inneholder den felles koden for å unngå duplisering!

Gå videre og opprett en common.php fil og lim inn følgende innhold i den filen.

$ verdi) $ params_string. = $ key. '='. $ verdi. '&';  rtrim ($ params_string, '&'); curl_setopt ($ ch, CURLOPT_POST, telle ($ params)); curl_setopt ($ ch, CURLOPT_POSTFIELDS, $ params_string);  // utfør innlegg $ result = curl_exec ($ ch); // Lukk forbindelse curl_close ($ ch); returnere $ resultat; 

Som du kan se, inneholder den bare en funksjon, do_curl_request, som vil gjøre et CURL-anrop til nettadressen som er passert av $ url argument. Det andre argumentet er en rekke parametere hvis du må POST dataene.

De andre viktige tingene å merke seg er CURLOPT_COOKIEJAR og  CURLOPT_COOKIEFILE innstillinger. Disse angir filen der informasjonskapslene skal lagres og leses fra. Som vi må gjøre godkjente samtaler, er det et must! Selvfølgelig vil du endre banen /tmp/apicookie.txt i henhold til systeminnstillingene dine. Pass på at den også skrives av webserveren!

Endelig returnerer funksjonen svaret fra CURL-forespørselen!

Slik logger du på

Åpenbart, det første du må gjøre er å starte økten, og du må bruke Logg Inn metode. La oss ta en titt på et eksempel. Gå videre og opprett en login.php fil med følgende innhold.

 'Demo_api_user', 'passord' => '5fbYF8oDteYSJhMQnXuxGB7jx7Ujk7zjJxuCwDSmZx3NJ47ARxW8Je70bYQrfpsfVamVXaMJ4GtHPxnu1ZX41JQN5Vy6V2XwaS6u5dMO6QDArRBc7P7RnriYyancCowlKVTNVUelIKGKmsTBZiPdcYAHX8n6pnSPvNa1wqfQaieKWux6fFZxIYlCstATe02UtFxvhzF82St2Cw0EhfC2rcFwDjQVAowMG1tGDAsIhz8EZa6ngSreD2qZQnqxg8Lm',); $ json = do_curl_request ($ url, $ felt); $ data = json_decode ($ json); var_dump ($ data);

Først har vi tatt med common.php fil opprettet i forrige seksjon. Deretter $ url variabel definerer API-loggfilen for OpenCart-butikken. Deretter $ felt array holder API-brukerens legitimasjonsinformasjon opprettet tidligere. Til slutt kaller vi do_curl_request metode for å logge inn.

Hvis alt er satt opp på riktig måte, bør du se en "Suksess: API-sesjon vellykket startet!" melding i svaret.

Gratulerer! Du har nettopp brukt innlogging REST API i OpenCart!

Slik legger du til et produkt i handlekurven

Så, nå som vi har logget inn, la oss begynne å legge til produkter i vognen vår! Lag en fil add_product.php med følgende innhold.

 '51', 'kvantitet' => '1'); $ json = do_curl_request ($ url, $ felt); $ data = json_decode ($ json); var_dump ($ data);

Igjen, ganske enkle ting her! Du må passere Produkt ID og mengde parametere for å legge produktet inn i handlekurven. Du bør se "Suksess: Du har endret handlekurven din!" melding i tilfelle suksess!

Slik redigerer du et produkt i handlekurven

Før vi går videre, la oss prøve å forstå hvordan OpenCart lagrer produktinformasjonen i handlevognobjektet. Slik ser kurvobjektet ut.

stdClass Object (... [produkter] => Array ([0] => stdClass Object ([key] => YToxOntzOjEwOiJwcm9kdWN0X2lkIjtpOjUwO30 = [product_id] => 51 [navn] => Demo Product [model] => demoprodukt [ Array () [quantity] => 1 [lager] => 1 [frakt] => 1 [pris] => $ 10,00 [totalt] => $ 20,00 [belønning] => 0)) ...)

Som du kan se, er den lagret som en serie referert av Produkter nøkkel. De nøkkel er også kryptert, så for å redigere produktoppføring i objektet, må du hente den tilknyttede nøkkel bruker Produkt ID i utgangspunktet!

Nå, la oss se hvordan du redigerer mengden av produktet i handlekurven. Lag en fil edit_product.php og lim inn følgende innhold i den filen.

produkter [0] -> nøkkel; // rediger produktet i "Cart" ved hjelp av "key" $ url = 'http: //your-opencart-store-url/index.php? route = api / cart / edit'; $ felt = array ('key' => $ product_key, 'quantity' => '2'); $ json = do_curl_request ($ url, $ felt); $ data = json_decode ($ json); var_dump ($ data);

Vi har laget to CURL-anrop i eksempelet ovenfor. Den første er å hente alle produktene i handlekurven, og den andre er å oppdatere mengden av produktet allerede i handlekurven!

For å redigere noe produkt, trenger du $ nøkkel for produktet, og du kan finne det ved å hente det komplette produktgruppen fra handlekurven.

For enkelhets skyld har jeg hentet nøkkelen ved hjelp av 0 indeks direkte. Men selvfølgelig må du finne den ved hjelp av Produkt ID.

$ product_key = $ products_data-> produkter [0] -> key;

Resten er enkel: vi passerer bare nøkkel og mengde Vi vil gjerne oppdatere for produktet! Igjen, bør du se "Suksess: Du har endret handlekurven din!" i svaret for å sørge for at mengden er oppdatert på riktig måte.

Så det er det for i dag. I neste del av denne opplæringen ser vi resten av eksemplene for å lage en ordre!

Konklusjon

I dag så vi på den viktige "REST APIs" -funksjonen i OpenCart. Vi gikk gjennom prosessen med å opprette en API-bruker, og senere utforsket vi noen praktiske eksempler for å forstå bruken av APIene. Jeg vil gjerne høre tankene dine om denne spennende funksjonen!