Get Portal
curl --request GET \
--url https://app.magna.so/api/external/v1/portals/{id} \
--header 'x-magna-api-token: <api-key>'import requests
url = "https://app.magna.so/api/external/v1/portals/{id}"
headers = {"x-magna-api-token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-magna-api-token': '<api-key>'}};
fetch('https://app.magna.so/api/external/v1/portals/{id}', 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://app.magna.so/api/external/v1/portals/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-magna-api-token: <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"
"net/http"
"io"
)
func main() {
url := "https://app.magna.so/api/external/v1/portals/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-magna-api-token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.magna.so/api/external/v1/portals/{id}")
.header("x-magna-api-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.magna.so/api/external/v1/portals/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-magna-api-token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"isProcessed": true,
"result": {
"id": "po...uuid",
"name": "Acme Claim Portal",
"projectId": "p...uuid",
"domains": [
"acme.demo-portal.magna.so"
],
"legalEntityName": "Acme Inc.",
"version": "V2",
"configuration": {
"...": "version-specific portal configuration"
},
"createdAt": "2024-04-15T21:26:21.000Z",
"updatedAt": "2024-04-15T21:26:21.000Z",
"claimConfig": {
"tokenId": "tok...uuid",
"contractId": "c...uuid",
"startTimestamp": "2024-05-01T00:00:00.000Z",
"endTimestamp": null
},
"auth": {
"magnaApiToken": null,
"terminal3": null,
"x": null
}
}
}Portals
Get Portal
Retrieve a single claim portal by ID, including its claim config and auth settings.
GET
/
api
/
external
/
v1
/
portals
/
{id}
Get Portal
curl --request GET \
--url https://app.magna.so/api/external/v1/portals/{id} \
--header 'x-magna-api-token: <api-key>'import requests
url = "https://app.magna.so/api/external/v1/portals/{id}"
headers = {"x-magna-api-token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-magna-api-token': '<api-key>'}};
fetch('https://app.magna.so/api/external/v1/portals/{id}', 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://app.magna.so/api/external/v1/portals/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-magna-api-token: <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"
"net/http"
"io"
)
func main() {
url := "https://app.magna.so/api/external/v1/portals/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-magna-api-token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.magna.so/api/external/v1/portals/{id}")
.header("x-magna-api-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.magna.so/api/external/v1/portals/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-magna-api-token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"isProcessed": true,
"result": {
"id": "po...uuid",
"name": "Acme Claim Portal",
"projectId": "p...uuid",
"domains": [
"acme.demo-portal.magna.so"
],
"legalEntityName": "Acme Inc.",
"version": "V2",
"configuration": {
"...": "version-specific portal configuration"
},
"createdAt": "2024-04-15T21:26:21.000Z",
"updatedAt": "2024-04-15T21:26:21.000Z",
"claimConfig": {
"tokenId": "tok...uuid",
"contractId": "c...uuid",
"startTimestamp": "2024-05-01T00:00:00.000Z",
"endTimestamp": null
},
"auth": {
"magnaApiToken": null,
"terminal3": null,
"x": null
}
}
}⌘I