Generate Signature

This endpoint is for integration with Niobi. It generates signature used in the requests.

POST /api/niobi-signature

Generate Signature

cURL

curl --request POST \
  --url https://sandbox.users.niobi.co/api/niobi-signature \
  --header 'Content-Type: application/json' \
  --data '
{
  "client_id": "K1PoY1WYricSpXh6Wm24txxxxxxxxxx",
  "sender": "Niobi integration",
  "salt": "mySalt12342423",
  "params": {
    "test": 123
  }
}
'

import requests

url = "https://sandbox.users.niobi.co/api/niobi-signature"

payload = {
    "client_id": "K1PoY1WYricSpXh6Wm24txxxxxxxxxx",
    "sender": "Niobi integration",
    "salt": "mySalt12342423",
    "params": { "test": 123 }
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    client_id: 'K1PoY1WYricSpXh6Wm24txxxxxxxxxx',
    sender: 'Niobi integration',
    salt: 'mySalt12342423',
    params: {test: 123}
  })
};

fetch('https://sandbox.users.niobi.co/api/niobi-signature', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox.users.niobi.co/api/niobi-signature",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'client_id' => 'K1PoY1WYricSpXh6Wm24txxxxxxxxxx',
    'sender' => 'Niobi integration',
    'salt' => 'mySalt12342423',
    'params' => [
        'test' => 123
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://sandbox.users.niobi.co/api/niobi-signature"

	payload := strings.NewReader("{\n  \"client_id\": \"K1PoY1WYricSpXh6Wm24txxxxxxxxxx\",\n  \"sender\": \"Niobi integration\",\n  \"salt\": \"mySalt12342423\",\n  \"params\": {\n    \"test\": 123\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://sandbox.users.niobi.co/api/niobi-signature")
  .header("Content-Type", "application/json")
  .body("{\n  \"client_id\": \"K1PoY1WYricSpXh6Wm24txxxxxxxxxx\",\n  \"sender\": \"Niobi integration\",\n  \"salt\": \"mySalt12342423\",\n  \"params\": {\n    \"test\": 123\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.users.niobi.co/api/niobi-signature")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"client_id\": \"K1PoY1WYricSpXh6Wm24txxxxxxxxxx\",\n  \"sender\": \"Niobi integration\",\n  \"salt\": \"mySalt12342423\",\n  \"params\": {\n    \"test\": 123\n  }\n}"

response = http.request(request)
puts response.read_body

200

{
  "success": true,
  "message": "Signature was generated successfully.",
  "data": {}
}

{
  "success": false,
  "message": "Entity integration record not found."
}

Body

application/json

Payload for Signature generation

client_id · string · required

Client ID generated when creating new api keys

Example:

"K1PoY1WYricSpXh6Wm24txxxxxxxxxx"

sender · string · required

the title of the integration

Example:

"Niobi integration"

salt · string · required

Salt for added security

Example:

"mySalt12342423"

params · object · required

Additional parameters for the request

Show child attributes

Response

200

application/json

Signature was generated successfully.

success · boolean

Example:

true

message · string

Success message

Example:

"Signature was generated successfully."

data · object

The generated data including the signature