Handleiding: magento - exactonline

Controleer eerst of je Magento webwinkelomgeving het gebruik van de REST API toestaat. Deze controle bestaat uit de volgende stappen. We gebruiken www.jouwwebwinkel.nl als de url van jouw webwinkel.

(i) Is de REST API toegankelijk? Dit test je met de url http://www.jouwwebwinkel.nl/api/rest/products. Zie je een 403 op je scherm verschijnen? Prima. Maar …

(ii) … zie je een 404-scherm? Dan wordt de url doorgeleid naar een foutpagina. Dit kan een probleem zijn van de .htaccess-file. In deze file moet de regel RewriteRule ^api/rest api.php?type=rest [QSA,L] aanwezig zijn. Zo niet, dan dien je deze toe te voegen.
Het probleem kan ook veroorzaakt worden door een instelling in de Apache webserver. Zie deze link voor meer informatie: http://magento.stackexchange.com/questions/29936/rest-api-returns-404.

(iii) Heeft de gebruikersnaam waarmee je de OAUTH sleutels hebt aangemaakt admin-rechten? Dat moet namelijk wel, anders kunnen de gegevens niet opgehaald worden uit de webwinkel.

(iv) Gebruik je in de hostingomgeving php-fpm fast-cgi? Dan kan het zijn dat de autorisatie-sleutels niet correct doorkomen. Deze link bevat meer informatie: http://www.magentogeek.com/magento-rest-api-solution-for-400-bad-request/. Voor webwinkels die gehost zijn bij byte.nl- shared hosting - speelt dit onder andere. Zij hebben een goede uitleg om dit op te lossen.

(v) In alle gevallen: Neem contact met ons op als je er niet uitkomt. Wij zien soms details in onze log-files staan die jullie mogelijk kunnen helpen om de problemen op te lossen.

1. Zet de caching in je webwinkel uit. Dit kun je doen via System > Cache Management. Na de installatie van de extensie kun je de caching weer aanzetten.

2. Installeren extensie. Pak de zipfile uit en installeer de bestanden onder je Magento root. Je kunt aan de structuur van de zipfile zien welke bestanden je waar moet plaatsen. Er worden geen bestanden overschreven.

3. Definieer de REST Role. Je definieert nu eerst een zgn Role die de factuurgegevens, inclusief belastingtarieven en betaalmethoden uit je webwinkel kan lezen. Hiervoor gan je naar System > Web Services > REST Roles. Om gebruik te maken van de extensie dien je een Role aan te maken van type Administrator. Je maakt deze door op Add Admin Role te klikken. Als je die al hebt kun je die Role hergebruiken.

Aan de linkerkant van het scherm staat een scherm met als titel Role Information. Klik op de sub-menu-link Role API Resources. Je ziet de optie REST API Calls to read invoices verschijnen. Vink alle blokjes onder deze optie aan en sla de gegevens op.

Je hebt nu ingesteld dat de koppeling recht heeft om de entiteiten facturen, belastingtarieven en betaalmethoden te lezen uit Magento, maar je hebt nog niet aangegeven welke gegevens per entiteit hij op mag halen.

4. Wijs de velden toe die gelezen mogen worden. Ga naar System > Web Services > REST Attributes. Open de User Type Admin. Je ziet hier wederom de optie REST API Calls to read invoices verschijnen. Vink weer alle opties aan en sla de gegevens op.

5. Koppel de administrator aan de REST role. Tot slot dien je de administrator toe te wijzen aan de REST role. Ga naar System > Permissies > Users. Klik de administrator aan van de webwinkel. Ga naar REST Role, de onderste optie in het menu links. Wijs de administrator van de webwinkel toe aan de Administrator REST Role.

De stappen voor het aanmaken van een Magento consumerkey en consumersecret zijn als volgt:
1. Log in als admin bij je Magento 1.x webwinkel.
2. Ga naar System > Web Services > REST OAuth Consumers.

3. Klik op Add new om de Magento sleutels aan te maken. De key en de secret zijn al ingevuld. Vul zelf de naam voor de koppeling in en de callback url. De waarde van de callback url moet zijn: https://interface.cloudinvoice.company/api/v1/servlet/magento/callback.php

4. Vul je administrator wachtwoord in Klik op Save / Opslaan. De key en secret van dit scherm vul je in een later hoofdstuk in bij de velden Consumerkey en Consumersecret van het instellingenscherm van de koppeling.

Het installeren en configureren van de extensie voor Magento 2.x bestaat uit de volgende stappen:

1. Configuratie. Er zijn twee Magento tabbladen die je moet invullen. Bij de eerste bedenken we een herkenbare naam en vullen de Callback URL (https://interface.cloudinvoice.company/api/v1/servlet/magento2/callback.php?cikey=UWLICENTIESLEUTEL) en de Identity link URL in (https://interface.cloudinvoice.company/api/v1/view/cloudinvoice/authenticate.php) en je password in. UWLICENTIESLEUTEL dient vervangen te worden door de licentiesleutel uit de email. Altijd slim even tussendoor te saven (rechtsboven). Daarna gaan we door naar het tweede tabblad API.

Je gaat nu de rechten toekennen: welke gegevens uit de webwinkel mag de koppeling gebruiken? In het plaatje staat expliciet aangegeven welke resources je dient aan te vinken. Daarna klink je SAVE rechtsboven in.

2. Activeren van de extensie. Je gaat nu de extensie activeren. Allereerst klik je op ACTIVATE.

Rechts boven in het volgende scherm moet je daartoe toestemming geven middels ALLOW knop.

En nu begrijp je eindelijk waarom Magento 2 ……… 'Magento 2' heet: er openen namelijk twee windows! Op de eerste window (dus buiten je Magento winkel):

Op dit aparte window vul je je webwinkel domeinnaam in en de koppeling sleutel die je per email hebt ontvangen bij aanmelding. Als je vervolgens op de Geef toestemming voor de koppeling knop drukt zul je zien dat in het andere scherm (van je Magento winkel) de activatie tot stand komt.

De extensie is nu volledig geactiveerd. Om het zeker te weten kun je nog even naar de status van je integratie kijken op het Integratie scherm binnen je Magento webwinkel. De status moet nu ACTIVE zijn.

Je bent nu klaar met de voorbereidingen in je Magento 2.x winkel.