Einrichten des Webhooks

API für Aufrufe zu Zahlungen Einrichten des Webhooks

Dieser Aufruf wird eingesetzt um den URL für einen Webhook zur Verarbeitung von Nachrichten einzurichten.

Authentifizierung anhand des Headers

Um Ihre Zahlungsaufrufe zu authentifizieren, setzen Sie die Authentifizierung der benutzerdefinierten Header durch Novalnet ein. Das benutzerdefinierte Headerfeld ist wie folgt aufgebaut:

Jeder Header eines Aufrufs wird unter Verwendung des Paymentzugriffsschlüssels key erstellt. Um Ihren Paymentzugriffsschlüssel zu erhalten, loggen Sie sich in Ihr Novalnet Admin-Portal und folgen Sie dem Pfad Projekte -> [Wählen Sie Ihr gewünschtes Projekt aus] -> API-Anmeldeinformationen -> Paymentzugriffsschlüssel
Der Paymentzugriffsschlüssel sollte mit einer Variante von Base64 codiert werden.
Der resultierende, mit Base64 codierte Wert, sollte in dem benutzerdefinierten Header in dem Feld X-NN-Access-Key an Novalnet übergeben werden.
Das benutzerdefinierte Header-Feld ist in dem Format
X-NN-Access-Key:base64_encoded_value spezifiziert.

Alle Zahlungsaufrufe müssen über eine HTTPS-Verbindung mit den entsprechenden Werten im Header ausgeführt werden, andernfalls schlägt der Aufruf mit einer Fehlermeldung zur Autorisierung fehl.

Ihr Paymentzugriffsschlüssel beinhaltet viele Privilegien, also stellen Sie sicher, dass Sie diesen sicher aufbewahren! Teilen Sie Ihren geheimen Paymentzugriffsschlüssel nicht in öffentlich zugänglichen Bereichen wie GitHub, in auf Kundenseite installiertem Code und so weiter.

Header des HTTP-Aufrufs

X-NN-Access-Key	`base64_encode({PAYMENT_ACCESS_KEY})`
Content-Type	application/json
Accept	application/json
Charset	utf-8

Endpunkt

URL:

https://payport.novalnet.de/v2/webhook/configure

<?php
// Need to enter your payment access key value here
$payment_access_key = '###YOUR_PAYMENT_ACCESS_KEY###';

// Now, have to encode the $payment_access_key value with the base64 encode
$encoded_data       = base64_encode($payment_access_key);

// Build the Headers array
$headers = [

// The Content-Type should be "application/json"
'Content-Type:application/json', 

// The charset should be "utf-8"
'Charset:utf-8', 

// Optional
'Accept:application/json', 

// The formed authenticate value (case-sensitive)
'X-NN-Access-Key:' . $encoded_data, 
];
?>

ERGEBNIS

HEADERS
[
    "Content-Type:application/json",
    "Charset:utf-8",
    "Accept:application/json",
    "X-NN-Access-Key:MTljYTE0ZTdlYTYzMjhhNDJlMGViMTNkNTg1ZTRjMjI="
]

CURL

-H 'Content-Type: application/json'
-H 'Charset:utf-8'
-H 'Accept: application/json'
-H 'X-NN-Access-Key:###YOUR_ENCODED_PAYMENT_ACCESS_KEY###'

ERGEBNIS

HEADERS
[
    "Content-Type:application/json",
    "Charset:utf-8",
    "Accept:application/json",
    "X-NN-Access-Key:MTljYTE0ZTdlYTYzMjhhNDJlMGViMTNkNTg1ZTRjMjI="
]

NODEJS

headers: {
		'Content-Type': 'application/json',
		'Content-Length': Buffer.byteLength(###POSTDATA###),
		'Charset': 'utf-8',
		'Accept': 'application/json',
		'X-NN-Access-Key': '###YOUR_ENCODED_PAYMENT_ACCESS_KEY###'
		},

ERGEBNIS

HEADERS
[
    "Content-Type:application/json",
    "Charset:utf-8",
    "Accept:application/json",
    "X-NN-Access-Key:MTljYTE0ZTdlYTYzMjhhNDJlMGViMTNkNTg1ZTRjMjI="
]

PYTHON

HEADERS = {
'Content-Type': 'application/json',
'Charset': 'utf-8',
'Accept': 'application/json',
'X-NN-Access-Key': '###YOUR_ENCODED_PAYMENT_ACCESS_KEY###'
}

ERGEBNIS

HEADERS
[
    "Content-Type:application/json",
    "Charset:utf-8",
    "Accept:application/json",
    "X-NN-Access-Key:MTljYTE0ZTdlYTYzMjhhNDJlMGViMTNkNTg1ZTRjMjI="
]

RUBY

request["Content-Type"] = "application/json"
request["Charset"] = "utf-8"
request["Accept"] = "application/json"
request["X-NN-Access-Key"] = "###YOUR_ENCODED_PAYMENT_ACCESS_KEY###"

ERGEBNIS

HEADERS
[
    "Content-Type:application/json",
    "Charset:utf-8",
    "Accept:application/json",
    "X-NN-Access-Key:MTljYTE0ZTdlYTYzMjhhNDJlMGViMTNkNTg1ZTRjMjI="
]

req.Header.Add("Content-Type", "application/json")
req.Header.Add("Charset", "utf-8")
req.Header.Add("Accept", "application/json")
req.Header.Add("X-NN-Access-Key", "###YOUR_ENCODED_PAYMENT_ACCESS_KEY###")

ERGEBNIS

HEADERS
[
    "Content-Type:application/json",
    "Charset:utf-8",
    "Accept:application/json",
    "X-NN-Access-Key:MTljYTE0ZTdlYTYzMjhhNDJlMGViMTNkNTg1ZTRjMjI="
]

JAVA

.header("Content-Type", "application/json")
.header("Charset", "utf-8")
.header("Accept", "application/json")
.header("X-NN-Access-Key", "###YOUR_ENCODED_PAYMENT_ACCESS_KEY###")

ERGEBNIS

HEADERS
[
    "Content-Type:application/json",
    "Charset:utf-8",
    "Accept:application/json",
    "X-NN-Access-Key:MTljYTE0ZTdlYTYzMjhhNDJlMGViMTNkNTg1ZTRjMjI="
]

CSHARP

request.Headers.Add("Charset", "utf-8");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("X-NN-Access-Key", "\"###YOUR_ENCODED_PAYMENT_ACCESS_KEY###\"");

ERGEBNIS

HEADERS
[
    "Content-Type:application/json",
    "Charset:utf-8",
    "Accept:application/json",
    "X-NN-Access-Key:MTljYTE0ZTdlYTYzMjhhNDJlMGViMTNkNTg1ZTRjMjI="
]

Liste der Parameter

Jeder Aufruf ist in sogenannte Objekte unterteilt, welche eine Einheit beschreiben.

Jeder Parameter ist mit Attributen versehen Pflichtfeld, Bedingungsabhängig, Freiwillig. Auf der Grundlage Ihrer Anforderungen können Sie diese Parameter entsprechend einsetzen.

merchant
Objekt

Parameter	Beschreibung
signature String Pflichtfeld 7ibc7ob5\|tuJEH3gNbeWJfIHah\|\|nbobljbnmdli0poys\|doU3HJVoym7MQ44qf7cpn7pc	Die Signatur des Händlerprojekts ist notwendig, um eine Transaktion zu verarbeiten. Sie dient als privater Schlüssel, den Sie finden, wenn Sie sich in das Novalnet Admin-Portal einloggen und dann folgenden Pfad einschlagen: Projekte -> [Wählen Sie Ihr gewünschtes Projekt aus] -> API-Anmeldeinformationen -> API Signature (Aktivierungsschlüssel des Produkts)

webhook
Objekt

Parameter	Beschreibung
url String Pflichtfeld https://developer.novalnet.de/demo/paymentform/v2/webhook.php	URL für Benachrichtigungen / Webhook an welchen die Informationen zur Benachrichtigung über Ereignisse geschickt werden, welche für die jeweilige Transaktion auftreten. Um mehr über Benachrichtigungen und Ereignisse zu erfahren, sehen Sie sich diesen Abschnitt an.

custom
Objekt

Parameter	Beschreibung
lang String Freiwillig DE	Sprachcode mit 2 Buchstaben gemäß dem ISO 639-1-Standard

result
Objekt

Parameter	Beschreibung
status String Pflichtfeld SUCCESS\|FAILURE	Status der API für die Transaktion
status_text String Pflichtfeld erfolgreich	Dem Entwickler angezeigte Nachricht, welche den aufgetretenen Fehler beschreibt und mögliche Schritte, um diesen zu korrigieren.
status_code Integer Pflichtfeld 100	Statuscode zur API für die Transaktion

<?php

// Need to enter your payment access key value here
$payment_access_key    = '###YOUR_PAYMENT_ACCESS_KEY###';

// Now, have to encode the $payment_access_key value with the base64 encode
$encoded_data          = base64_encode($payment_access_key);

// Action Endpoint 
$endpoint              = 'https://payport.novalnet.de/v2/webhook/configure';

// Build the Headers array
$headers = [

	// The Content-Type should be "application/json"
    'Content-Type:application/json',
     
    // The charset should be "utf-8"
    'Charset:utf-8', 
    
    // Optional
    'Accept:application/json', 
    
    // The formed authenticate value (case-sensitive)
    'X-NN-Access-Key:' . $encoded_data, 
];

$data = [];

// Build Merchant Data
$data['merchant'] = [

	// The API signature value
    'signature' => '###YOUR_API_SIGNATURE###', 
];

// Build Webhook Data
$data['webhook'] = [

	// The Notify URL value for this particular transaction
    'url' => '###YOUR_HOOK_URL###', 
];

// Custom Data
$data['custom'] = [
	
	// Merchant's selected language
	'lang'      => 'DE',
];

// Convert the array to JSON string
$json_data = json_encode($data);

// Handle Response
$response = send_request($json_data, $endpoint, $headers);

function send_request($data, $url, $headers) {

    // Initiate cURL
    $curl = curl_init();
    
    // Set the url
    curl_setopt($curl, CURLOPT_URL, $url);
    
    // Set the result output to be a string
    curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
    
    // Set the POST value to true (mandatory)
    curl_setopt($curl, CURLOPT_POST, true);
    
    // Set the post fields
    curl_setopt($curl, CURLOPT_POSTFIELDS, $data);
    
    // Set the headers
    curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);

    // Execute cURL
    $result = curl_exec($curl);

    // Handle cURL error
	if (curl_errno($curl)) {
		echo 'Request Error:' . curl_error($curl);
		return $result;
	}
	// Close cURL
	curl_close($curl);  
	
	// Decode the JSON string
	$result = json_decode($result);
	
	return $result;
}

?>

{
  "merchant":{
    "signature":"###YOUR_API_SIGNATURE###"
  },
  "webhook":{
    "url":"###YOUR_HOOK_URL###"
  },
  "custom":{
    "lang":"DE"
  }
}

{
  "result":{
    "status":"SUCCESS",
    "status_code":100,
     "status_text":"erfolgreich"
  }
}

CURL

curl --location --request POST 'https://payport.novalnet.de/v2/webhook/configure' -H 'Content-Type: application/json' -H 'Charset:utf-8' -H 'Accept: application/json' -H 'X-NN-Access-Key: ###YOUR_ENCODED_PAYMENT_ACCESS_KEY###' -d '{"merchant":{"signature":"###YOUR_API_SIGNATURE###"},"webhook":{"url":"###YOUR_HOOK_URL###"},"custom":{"lang":"DE"}}';

{
  "merchant":{
    "signature":"###YOUR_API_SIGNATURE###"
  },
  "webhook":{
    "url":"###YOUR_HOOK_URL###"
  },
  "custom":{
    "lang":"DE"
  }
}

{
  "result":{
    "status":"SUCCESS",
    "status_code":100,
     "status_text":"erfolgreich"
  }
}

NODEJS

#!/usr/bin/node

const https = require('https');
// data sent in the body of the request
const postData = JSON.stringify({
  "merchant": {
    "signature": "###YOUR_API_SIGNATURE###"
  },
  "webhook": {
    "url": "###YOUR_HOOK_URL###"
  },
  "custom": {
    "lang": "DE"
  }
});

const options = {
  hostname: 'payport.novalnet.de',
  port: 443,
  path: '/v2/webhook/configure',
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Content-Length': Buffer.byteLength(postData),
    'Charset': 'utf-8',
    'Accept': 'application/json',
    'X-NN-Access-Key': '"###YOUR_ENCODED_PAYMENT_ACCESS_KEY###"'
  },
};

const req = https.request(options, (res) => {
  console.log('statusCode:', res.statusCode);
  // console.log('headers:', res.headers);

  res.on('data', (d) => {
    process.stdout.write(d);
  });
});

req.on('error', (e) => {
  console.error('ERROR: ',e);
});

// Write data to request body
req.write(postData);
req.end();

{
  "merchant":{
    "signature":"###YOUR_API_SIGNATURE###"
  },
  "webhook":{
    "url":"###YOUR_HOOK_URL###"
  },
  "custom":{
    "lang":"DE"
  }
}

{
  "result":{
    "status":"SUCCESS",
    "status_code":100,
     "status_text":"erfolgreich"
  }
}

PYTHON

#!/usr/bin/python3
import http.client
import json

CONN = http.client.HTTPSConnection("payport.novalnet.de")
PAYLOAD = json.dumps({
  "merchant": {
    "signature": "###YOUR_API_SIGNATURE###"
  },
  "webhook": {
    "url": "###YOUR_HOOK_URL###"
  },
  "custom": {
    "lang": "DE"
  }
})

HEADERS = {
  'Content-Type': 'application/json',
  'Charset': 'utf-8',
  'Accept': 'application/json',
  'X-NN-Access-Key': '"###YOUR_ENCODED_PAYMENT_ACCESS_KEY###"'
}
CONN.request("POST", "/v2/webhook/configure", PAYLOAD, HEADERS)
RES = CONN.getresponse()
DATA = RES.read()
print(DATA.decode("utf-8"))

{
  "merchant":{
    "signature":"###YOUR_API_SIGNATURE###"
  },
  "webhook":{
    "url":"###YOUR_HOOK_URL###"
  },
  "custom":{
    "lang":"DE"
  }
}

{
  "result":{
    "status":"SUCCESS",
    "status_code":100,
     "status_text":"erfolgreich"
  }
}

RUBY

#!/usr/bin/ruby
require "uri"
require "json"
require "net/http"

url = URI("https://payport.novalnet.de/v2/webhook/configure")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/json"
request["Charset"] = "utf-8"
request["Accept"] = "application/json"
request["X-NN-Access-Key"] = "\"###YOUR_ENCODED_PAYMENT_ACCESS_KEY###\""
request.body = JSON.dump({
  "merchant": {
    "signature": "###YOUR_API_SIGNATURE###"
  },
  "webhook": {
    "url": "###YOUR_HOOK_URL###"
  },
  "custom": {
    "lang": "DE"
  }
})
response = https.request(request)
puts response.read_body

{
  "merchant":{
    "signature":"###YOUR_API_SIGNATURE###"
  },
  "webhook":{
    "url":"###YOUR_HOOK_URL###"
  },
  "custom":{
    "lang":"DE"
  }
}

{
  "result":{
    "status":"SUCCESS",
    "status_code":100,
     "status_text":"erfolgreich"
  }
}

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://payport.novalnet.de/v2/webhook/configure"
  method := "POST"

  payload := strings.NewReader(`{
	  "merchant": {
		"signature": "###YOUR_API_SIGNATURE###"
	  },
	  "webhook": {
		"url": "###YOUR_HOOK_URL###"
	  },
	  "custom": {
		"lang": "DE"
	  }
	}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/json")
  req.Header.Add("Charset", "utf-8")
  req.Header.Add("Accept", "application/json")
  req.Header.Add("X-NN-Access-Key", "\"###YOUR_ENCODED_PAYMENT_ACCESS_KEY###\"")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

{
  "merchant":{
    "signature":"###YOUR_API_SIGNATURE###"
  },
  "webhook":{
    "url":"###YOUR_HOOK_URL###"
  },
  "custom":{
    "lang":"DE"
  }
}

{
  "result":{
    "status":"SUCCESS",
    "status_code":100,
     "status_text":"erfolgreich"
  }
}

JAVA

/* List of required libraries (see also the import statements below): 
- commons-logging-1.2.jar    
- httpasyncclient-4.1.5.jar  
- httpclient-4.3.3.jar  
- httpcore-4.4.16.jar   
- httpcore-nio-4.4.16.jar  
- httpmime-4.5.14.jar      
- json-20230227.jar  
- unirest-java-3.9.00.jar
*/

import org.json.JSONArray;
import org.apache.http.auth.*;
import org.apache.http.nio.conn.*; 
import org.apache.http.concurrent.*;
import org.apache.http.nio.reactor.*;
import org.apache.commons.logging.*;
import org.apache.http.entity.mime.content.*; 
import kong.unirest.*;

public class CancelRequest {
  public void send_test_request() {
    Unirest.config().connectTimeout(1000).socketTimeout(2000);
    HttpResponse<String> response = Unirest.post("https://payport.novalnet.de/v2/webhook/configure")
    .header("Content-Type", "application/json")
    .header("Charset", "utf-8")
    .header("Accept", "application/json")
    .header("X-NN-Access-Key", "\"###YOUR_ENCODED_PAYMENT_ACCESS_KEY###\"")
    .body("{\"merchant\":{\"signature\":\"###YOUR_API_SIGNATURE###\"},\"webhook\":{\"url\":\"###YOUR_HOOK_URL###\"},\"custom\":{\"lang\":\"DE\"}}")
    .asString();
    System.out.println(response.getBody());
  }
  public static void main(String[] args) {
    CancelRequest requestClient = new CancelRequest();
    requestClient.send_test_request();
  }

}

{
  "merchant":{
    "signature":"###YOUR_API_SIGNATURE###"
  },
  "webhook":{
    "url":"###YOUR_HOOK_URL###"
  },
  "custom":{
    "lang":"DE"
  }
}

{
  "result":{
    "status":"SUCCESS",
    "status_code":100,
     "status_text":"erfolgreich"
  }
}

CSHARP

using System;
/*using System.Net.Http.WebRequest; */
using System.Net.Http;

namespace WebhookConfigureRequest
{
  public class WebhookConfigure {

    public string check_webhookconfigure_request() {
      var client = new HttpClient();
      var request = new HttpRequestMessage(HttpMethod.Post, "https://payport.novalnet.de/v2/webhook/configure");

      request.Headers.Add("Charset", "utf-8");
      request.Headers.Add("Accept", "application/json");
      request.Headers.Add("X-NN-Access-Key", "\"###YOUR_ENCODED_PAYMENT_ACCESS_KEY###\"");
      var content = new StringContent("{\"merchant\":{\"signature\":\"###YOUR_API_SIGNATURE###\"},\"webhook\":{\"url\":\"###YOUR_HOOK_URL###\"},\"custom\":{\"lang\":\"DE\"}}", null, "application/json");
      request.Content = content;
      var response = client.SendAsync(request).Result;
      response.EnsureSuccessStatusCode();
      var responseText = response.Content.ReadAsStringAsync().Result;
      Console.WriteLine(responseText);
      return responseText;

    }

    public static void Main() {
      var testRequest = new WebhookConfigure();
      testRequest.check_webhookconfigure_request(); 
    }

  }
}

{
  "merchant":{
    "signature":"###YOUR_API_SIGNATURE###"
  },
  "webhook":{
    "url":"###YOUR_HOOK_URL###"
  },
  "custom":{
    "lang":"DE"
  }
}

{
  "result":{
    "status":"SUCCESS",
    "status_code":100,
     "status_text":"erfolgreich"
  }
}