Generate API Key
curl --request POST \
--url https://staging-api.getpartna.com/v4/user/apikey \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--header 'x-api-user: <api-key>' \
--data '
{
"apikey": "",
"expirationInDays": 0,
"expirationInMonths": 0,
"keyname": "",
"otp": "",
"scope": ""
}
'import requests
url = "https://staging-api.getpartna.com/v4/user/apikey"
payload = {
"apikey": "",
"expirationInDays": 0,
"expirationInMonths": 0,
"keyname": "",
"otp": "",
"scope": ""
}
headers = {
"x-api-key": "<api-key>",
"x-api-user": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-api-key': '<api-key>',
'x-api-user': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
apikey: '',
expirationInDays: 0,
expirationInMonths: 0,
keyname: '',
otp: '',
scope: ''
})
};
fetch('https://staging-api.getpartna.com/v4/user/apikey', 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://staging-api.getpartna.com/v4/user/apikey",
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([
'apikey' => '',
'expirationInDays' => 0,
'expirationInMonths' => 0,
'keyname' => '',
'otp' => '',
'scope' => ''
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>",
"x-api-user: <api-key>"
],
]);
$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://staging-api.getpartna.com/v4/user/apikey"
payload := strings.NewReader("{\n \"apikey\": \"\",\n \"expirationInDays\": 0,\n \"expirationInMonths\": 0,\n \"keyname\": \"\",\n \"otp\": \"\",\n \"scope\": \"\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-api-user", "<api-key>")
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://staging-api.getpartna.com/v4/user/apikey")
.header("x-api-key", "<api-key>")
.header("x-api-user", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"apikey\": \"\",\n \"expirationInDays\": 0,\n \"expirationInMonths\": 0,\n \"keyname\": \"\",\n \"otp\": \"\",\n \"scope\": \"\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://staging-api.getpartna.com/v4/user/apikey")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["x-api-user"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"apikey\": \"\",\n \"expirationInDays\": 0,\n \"expirationInMonths\": 0,\n \"keyname\": \"\",\n \"otp\": \"\",\n \"scope\": \"\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"apikey": "1--M--4fca371417414423ace78dc730b46e81--1781793658613--3677a356"
},
"message": "success"
}{
"message": "invalid API scope"
}User
Generate API Key
Generate user API keys.
POST
/
user
/
apikey
Generate API Key
curl --request POST \
--url https://staging-api.getpartna.com/v4/user/apikey \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--header 'x-api-user: <api-key>' \
--data '
{
"apikey": "",
"expirationInDays": 0,
"expirationInMonths": 0,
"keyname": "",
"otp": "",
"scope": ""
}
'import requests
url = "https://staging-api.getpartna.com/v4/user/apikey"
payload = {
"apikey": "",
"expirationInDays": 0,
"expirationInMonths": 0,
"keyname": "",
"otp": "",
"scope": ""
}
headers = {
"x-api-key": "<api-key>",
"x-api-user": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-api-key': '<api-key>',
'x-api-user': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
apikey: '',
expirationInDays: 0,
expirationInMonths: 0,
keyname: '',
otp: '',
scope: ''
})
};
fetch('https://staging-api.getpartna.com/v4/user/apikey', 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://staging-api.getpartna.com/v4/user/apikey",
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([
'apikey' => '',
'expirationInDays' => 0,
'expirationInMonths' => 0,
'keyname' => '',
'otp' => '',
'scope' => ''
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>",
"x-api-user: <api-key>"
],
]);
$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://staging-api.getpartna.com/v4/user/apikey"
payload := strings.NewReader("{\n \"apikey\": \"\",\n \"expirationInDays\": 0,\n \"expirationInMonths\": 0,\n \"keyname\": \"\",\n \"otp\": \"\",\n \"scope\": \"\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-api-user", "<api-key>")
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://staging-api.getpartna.com/v4/user/apikey")
.header("x-api-key", "<api-key>")
.header("x-api-user", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"apikey\": \"\",\n \"expirationInDays\": 0,\n \"expirationInMonths\": 0,\n \"keyname\": \"\",\n \"otp\": \"\",\n \"scope\": \"\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://staging-api.getpartna.com/v4/user/apikey")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["x-api-user"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"apikey\": \"\",\n \"expirationInDays\": 0,\n \"expirationInMonths\": 0,\n \"keyname\": \"\",\n \"otp\": \"\",\n \"scope\": \"\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"apikey": "1--M--4fca371417414423ace78dc730b46e81--1781793658613--3677a356"
},
"message": "success"
}{
"message": "invalid API scope"
}Authorizations
x-api-key & x-api-userauthorization
Body
application/json
key identifier of the user's choice
permission level of the apiKey; get api key scopes to see valid scopes; use M for a master key; G for a get only key; W for a withdrawal permitted key; and N for a no withdrawal key
supplied if there's an existing api key that needs to be deleted
Was this page helpful?
⌘I