Create device
curl --request POST \
--url https://api.clinikapi.com/v1/devices \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"deviceName": "<string>",
"manufacturer": "<string>",
"modelNumber": "<string>",
"serialNumber": "<string>",
"lotNumber": "<string>",
"manufactureDate": "<string>",
"expirationDate": "<string>",
"type": "<string>",
"patientId": "<string>",
"ownerId": "<string>",
"locationId": "<string>",
"url": "<string>",
"note": "<string>",
"parentId": "<string>",
"udiCarrier": [
{
"deviceIdentifier": "<string>",
"carrierHRF": "<string>"
}
],
"safety": [
"<string>"
]
}
'import requests
url = "https://api.clinikapi.com/v1/devices"
payload = {
"deviceName": "<string>",
"manufacturer": "<string>",
"modelNumber": "<string>",
"serialNumber": "<string>",
"lotNumber": "<string>",
"manufactureDate": "<string>",
"expirationDate": "<string>",
"type": "<string>",
"patientId": "<string>",
"ownerId": "<string>",
"locationId": "<string>",
"url": "<string>",
"note": "<string>",
"parentId": "<string>",
"udiCarrier": [
{
"deviceIdentifier": "<string>",
"carrierHRF": "<string>"
}
],
"safety": ["<string>"]
}
headers = {
"x-api-key": "<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>', 'Content-Type': 'application/json'},
body: JSON.stringify({
deviceName: '<string>',
manufacturer: '<string>',
modelNumber: '<string>',
serialNumber: '<string>',
lotNumber: '<string>',
manufactureDate: '<string>',
expirationDate: '<string>',
type: '<string>',
patientId: '<string>',
ownerId: '<string>',
locationId: '<string>',
url: '<string>',
note: '<string>',
parentId: '<string>',
udiCarrier: [{deviceIdentifier: '<string>', carrierHRF: '<string>'}],
safety: ['<string>']
})
};
fetch('https://api.clinikapi.com/v1/devices', 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://api.clinikapi.com/v1/devices",
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([
'deviceName' => '<string>',
'manufacturer' => '<string>',
'modelNumber' => '<string>',
'serialNumber' => '<string>',
'lotNumber' => '<string>',
'manufactureDate' => '<string>',
'expirationDate' => '<string>',
'type' => '<string>',
'patientId' => '<string>',
'ownerId' => '<string>',
'locationId' => '<string>',
'url' => '<string>',
'note' => '<string>',
'parentId' => '<string>',
'udiCarrier' => [
[
'deviceIdentifier' => '<string>',
'carrierHRF' => '<string>'
]
],
'safety' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <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://api.clinikapi.com/v1/devices"
payload := strings.NewReader("{\n \"deviceName\": \"<string>\",\n \"manufacturer\": \"<string>\",\n \"modelNumber\": \"<string>\",\n \"serialNumber\": \"<string>\",\n \"lotNumber\": \"<string>\",\n \"manufactureDate\": \"<string>\",\n \"expirationDate\": \"<string>\",\n \"type\": \"<string>\",\n \"patientId\": \"<string>\",\n \"ownerId\": \"<string>\",\n \"locationId\": \"<string>\",\n \"url\": \"<string>\",\n \"note\": \"<string>\",\n \"parentId\": \"<string>\",\n \"udiCarrier\": [\n {\n \"deviceIdentifier\": \"<string>\",\n \"carrierHRF\": \"<string>\"\n }\n ],\n \"safety\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<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://api.clinikapi.com/v1/devices")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"deviceName\": \"<string>\",\n \"manufacturer\": \"<string>\",\n \"modelNumber\": \"<string>\",\n \"serialNumber\": \"<string>\",\n \"lotNumber\": \"<string>\",\n \"manufactureDate\": \"<string>\",\n \"expirationDate\": \"<string>\",\n \"type\": \"<string>\",\n \"patientId\": \"<string>\",\n \"ownerId\": \"<string>\",\n \"locationId\": \"<string>\",\n \"url\": \"<string>\",\n \"note\": \"<string>\",\n \"parentId\": \"<string>\",\n \"udiCarrier\": [\n {\n \"deviceIdentifier\": \"<string>\",\n \"carrierHRF\": \"<string>\"\n }\n ],\n \"safety\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clinikapi.com/v1/devices")
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["Content-Type"] = 'application/json'
request.body = "{\n \"deviceName\": \"<string>\",\n \"manufacturer\": \"<string>\",\n \"modelNumber\": \"<string>\",\n \"serialNumber\": \"<string>\",\n \"lotNumber\": \"<string>\",\n \"manufactureDate\": \"<string>\",\n \"expirationDate\": \"<string>\",\n \"type\": \"<string>\",\n \"patientId\": \"<string>\",\n \"ownerId\": \"<string>\",\n \"locationId\": \"<string>\",\n \"url\": \"<string>\",\n \"note\": \"<string>\",\n \"parentId\": \"<string>\",\n \"udiCarrier\": [\n {\n \"deviceIdentifier\": \"<string>\",\n \"carrierHRF\": \"<string>\"\n }\n ],\n \"safety\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_bodyDevices
Create Device
POST
/
v1
/
devices
Create device
curl --request POST \
--url https://api.clinikapi.com/v1/devices \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"deviceName": "<string>",
"manufacturer": "<string>",
"modelNumber": "<string>",
"serialNumber": "<string>",
"lotNumber": "<string>",
"manufactureDate": "<string>",
"expirationDate": "<string>",
"type": "<string>",
"patientId": "<string>",
"ownerId": "<string>",
"locationId": "<string>",
"url": "<string>",
"note": "<string>",
"parentId": "<string>",
"udiCarrier": [
{
"deviceIdentifier": "<string>",
"carrierHRF": "<string>"
}
],
"safety": [
"<string>"
]
}
'import requests
url = "https://api.clinikapi.com/v1/devices"
payload = {
"deviceName": "<string>",
"manufacturer": "<string>",
"modelNumber": "<string>",
"serialNumber": "<string>",
"lotNumber": "<string>",
"manufactureDate": "<string>",
"expirationDate": "<string>",
"type": "<string>",
"patientId": "<string>",
"ownerId": "<string>",
"locationId": "<string>",
"url": "<string>",
"note": "<string>",
"parentId": "<string>",
"udiCarrier": [
{
"deviceIdentifier": "<string>",
"carrierHRF": "<string>"
}
],
"safety": ["<string>"]
}
headers = {
"x-api-key": "<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>', 'Content-Type': 'application/json'},
body: JSON.stringify({
deviceName: '<string>',
manufacturer: '<string>',
modelNumber: '<string>',
serialNumber: '<string>',
lotNumber: '<string>',
manufactureDate: '<string>',
expirationDate: '<string>',
type: '<string>',
patientId: '<string>',
ownerId: '<string>',
locationId: '<string>',
url: '<string>',
note: '<string>',
parentId: '<string>',
udiCarrier: [{deviceIdentifier: '<string>', carrierHRF: '<string>'}],
safety: ['<string>']
})
};
fetch('https://api.clinikapi.com/v1/devices', 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://api.clinikapi.com/v1/devices",
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([
'deviceName' => '<string>',
'manufacturer' => '<string>',
'modelNumber' => '<string>',
'serialNumber' => '<string>',
'lotNumber' => '<string>',
'manufactureDate' => '<string>',
'expirationDate' => '<string>',
'type' => '<string>',
'patientId' => '<string>',
'ownerId' => '<string>',
'locationId' => '<string>',
'url' => '<string>',
'note' => '<string>',
'parentId' => '<string>',
'udiCarrier' => [
[
'deviceIdentifier' => '<string>',
'carrierHRF' => '<string>'
]
],
'safety' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <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://api.clinikapi.com/v1/devices"
payload := strings.NewReader("{\n \"deviceName\": \"<string>\",\n \"manufacturer\": \"<string>\",\n \"modelNumber\": \"<string>\",\n \"serialNumber\": \"<string>\",\n \"lotNumber\": \"<string>\",\n \"manufactureDate\": \"<string>\",\n \"expirationDate\": \"<string>\",\n \"type\": \"<string>\",\n \"patientId\": \"<string>\",\n \"ownerId\": \"<string>\",\n \"locationId\": \"<string>\",\n \"url\": \"<string>\",\n \"note\": \"<string>\",\n \"parentId\": \"<string>\",\n \"udiCarrier\": [\n {\n \"deviceIdentifier\": \"<string>\",\n \"carrierHRF\": \"<string>\"\n }\n ],\n \"safety\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<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://api.clinikapi.com/v1/devices")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"deviceName\": \"<string>\",\n \"manufacturer\": \"<string>\",\n \"modelNumber\": \"<string>\",\n \"serialNumber\": \"<string>\",\n \"lotNumber\": \"<string>\",\n \"manufactureDate\": \"<string>\",\n \"expirationDate\": \"<string>\",\n \"type\": \"<string>\",\n \"patientId\": \"<string>\",\n \"ownerId\": \"<string>\",\n \"locationId\": \"<string>\",\n \"url\": \"<string>\",\n \"note\": \"<string>\",\n \"parentId\": \"<string>\",\n \"udiCarrier\": [\n {\n \"deviceIdentifier\": \"<string>\",\n \"carrierHRF\": \"<string>\"\n }\n ],\n \"safety\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clinikapi.com/v1/devices")
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["Content-Type"] = 'application/json'
request.body = "{\n \"deviceName\": \"<string>\",\n \"manufacturer\": \"<string>\",\n \"modelNumber\": \"<string>\",\n \"serialNumber\": \"<string>\",\n \"lotNumber\": \"<string>\",\n \"manufactureDate\": \"<string>\",\n \"expirationDate\": \"<string>\",\n \"type\": \"<string>\",\n \"patientId\": \"<string>\",\n \"ownerId\": \"<string>\",\n \"locationId\": \"<string>\",\n \"url\": \"<string>\",\n \"note\": \"<string>\",\n \"parentId\": \"<string>\",\n \"udiCarrier\": [\n {\n \"deviceIdentifier\": \"<string>\",\n \"carrierHRF\": \"<string>\"\n }\n ],\n \"safety\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
Your ClinikAPI secret key (clk_live_* or clk_test_*)
Body
application/json
Maximum string length:
500Available options:
active, inactive Maximum string length:
500Maximum string length:
200Maximum string length:
200Maximum string length:
200Maximum string length:
200Maximum string length:
128Maximum string length:
128Maximum string length:
128Maximum string length:
2000Maximum string length:
5000Maximum string length:
128Maximum array length:
10Show child attributes
Show child attributes
Maximum array length:
20Maximum string length:
200Response
201
Device created
⌘I