2Solar API documentatie

2Solar beschikt over een open API. In dit artikel zijn handige links terug te vinden omtrent deze API.

De algemene API documentatie is hier te vinden.

De basis URL die standaard gebruikt moet worden binnen het koppelen met onze API is als volgt: https://app.2solar.nl/api/ afhankelijk van het API type welke er op dat moment gebruikt wordt, dient er nog een extra extensie toegevoegd te worden aan de URL (deze is ten alle tijde terug te vinden op de pagina van de desbetreffende API). Bijvoorbeeld person. Dit ziet er dan als volgt uit: https://app.2solar.nl/api/person

2Solar API in combinatie met Wordpress & Ninja Forms

Indien de website is gebouwd in WordPress waarin een contactformulier van Ninja Forms verwerkt zit, kan deze gekoppeld worden aan onze Person POST API. Om dit te kunnen doen, dient er een plugin gedownload te worden. Deze plugin is hier te vinden.

Wanneer deze plugin is geïnstalleerd, kan de integratie gereed worden gemaakt. Dit kan door naar het formulier te gaan binnen de WordPress admin omgeving en dan op de tab "Emails en Acties" te klikken. Hier staat dan nu ook een switch bij met "Webhooks" erachter. Zie onderstaande afbeelding voor een visuele uitleg:

Onderstaande is van belang:
Onder de kop "Verbeteringen" dienen er nog wat switches omgezet te worden. Zie onderstaand screenshot met hoe dit er uit zou moeten komen te zien:

2Solar API in combinatie met Wordpress & Gravity Forms

Indien de website is gebouwd in WordPress waarin een contactformulier van Gravity Forms verwerkt zit, kan deze gekoppeld worden aan onze Person POST API. Om dit te kunnen doen, dient er een plugin gedownload te worden. Deze plugin is hier te vinden.

Wanneer deze plugin is geïnstalleerd, kan de integratie gereed worden gemaakt. Dit kan door naar het formulier te gaan binnen de WordPress admin omgeving en dan de volgende stappen uit te voeren:

1. Open het formulier waarvan je de aanvragen in 2solar wilt laten landen en kies voor instellingen "Webhooks":

   

2. Implementeer de webhook, vul hiervoor de volgende data in in de velden:

   1. Aanvraag URL; https://app.2solar.nl/api/person

   2. Methode; POST

   3. Formaat; JSON

   4. "Het blok Aanvraag headers"

      1. Naam; Authorization

      2. Waarde; Bearer [zet hier de API key neer]

   5. "Het blok Body verzoek"

      1. Selecteer het rondje "Velden selecteren"

   6. "Het blok Veldwaarden"

      1. Sleutel; zet hier de key neer welke terug te vinden is in onze API documentatie.

      2. Waarde; selecteer hier het veld waar van uit de data moet weggeschreven worden in 2Solar. Dit kan door op de dropdown te klikken en het juiste veld aan te klikken.

      

   7. Sla alles op, en voer een test aanvraag in en kijk of deze binnen komt.

Voorbeeld API call van de 2Solar Person POST API (PHP)

Dit script bevat een basis opzet van hoe de Person POST API aangeroepen zou kunnen worden, let hierbij wel op. Dit is een PHP script in combinatie met cURL:

<?php
 
$curl = curl_init();
 
$data = [
    'postcode' => '8011CT',
    'number' => '19c',
    ...
];

$apiToken = 'Place your API key here';
 
curl_setopt_array($curl, [
    CURLOPT_URL => 'https://app.2solar.nl/api/person',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => json_encode($data),
    CURLOPT_HTTPHEADER => [
        'Content-Type:application/json',
        'Authorization: Bearer ' . $apiToken,
    ],
]);
 
$response = curl_exec($curl);
$err = curl_error($curl);
 
curl_close($curl);
 
if ($err) {
    echo 'cURL Error #:' . $err;
} else {
    echo $response;
}
?>

GET API

In de GET API's krijg je verschillende velden terug. In de documentatie zelf zijn velden met een standaard waarde terug te vinden. Hieronder een uitgebreide uitleg voor een aantal velden :

(mocht je toch vragen hebben over een specifiek veld, neem contact op via support@2solar.nl)