Lire les paramètres de l'entité

curl --request GET \
  --url https://partner-api.marko.fr/v1/settings \
  --header 'Authorization: Bearer <token>'

const url = 'https://partner-api.marko.fr/v1/settings';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://partner-api.marko.fr/v1/settings', 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://partner-api.marko.fr/v1/settings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

{
  "id": "11111111-1111-1111-1111-111111111111",
  "name": "Clubfunding",
  "type": "example",
  "mode_reporting": "trimestriel",
  "frequence_reporting": 3,
  "risk_threshold": 75,
  "portfolio_goals": {},
  "ai_enabled": true
}

{
  "type": "about:blank",
  "title": "Unauthorized",
  "status": 401,
  "detail": "A valid bearer token is required.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Forbidden",
  "status": 403,
  "detail": "The API key does not allow this operation.",
  "request_id": "req_example_partner_call"
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "type": "about:blank",
  "request_id": "<string>",
  "scope": "<string>",
  "route_id": "<string>",
  "reason_code": "<string>"
}

{
  "type": "about:blank",
  "title": "Unprocessable Content",
  "status": 422,
  "detail": "The request payload or parameters are invalid.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Too Many Requests",
  "status": 429,
  "detail": "The request rate limit was exceeded.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "An unexpected server error occurred.",
  "request_id": "req_example_partner_call"
}

Authorizations

Authorization

string

header

required

Use the access_token returned by POST /v1/auth/token. Do not send the raw API secret on business endpoints.

Headers

X-Request-ID

string

Partner-generated correlation identifier echoed in logs and error payloads.

Response

Successful response

Entity settings response.

string

required

Identifiant MARKO de la ressource.

name

string

required

Nom de la ressource. Les recherches exactes et partielles sont décrites au niveau de la route.

type

string

required

Type de l'entité MARKO.

mode_reporting

string

required

Mode de reporting configuré pour l'entité.

frequence_reporting

integer

required

Fréquence de reporting configurée pour l'entité.

portfolio_goals

Portfolio Goals · object

required

Objet JSON extensible. Les types des valeurs sont indiqués par additionalProperties lorsque la route les contraint.

siren

string | null

SIREN français sur 9 chiffres; le service vérifie aussi le checksum lorsque la route le prévoit.

date_reference_reporting

string<date> | null

Date de référence utilisée par le reporting de l'entité.

risk_threshold

integer

default:60

Seuil de risque configuré pour l'entité.

zone_vacances

string

default:C

Zone de vacances configurée pour la planification de l'entité.

report_external_neutrality

boolean

default:true

Paramètre de neutralité du reporting externe de l'entité.

logo_url

string | null

URL du logo de l'entité.

primary_color

string | null

Couleur principale de la marque de l'entité.

secondary_color

string | null

Couleur secondaire de la marque de l'entité.

brand_baseline

string | null

Texte de signature associé à la marque de l'entité.

email_brand_name

string | null

Nom de marque utilisé dans les e-mails de l'entité.

email_from_address

string<email> | null

Adresse d'expédition configurée pour les e-mails.

email_reply_to

string<email> | null

Adresse proposée pour répondre aux e-mails.

email_branding_mode

enum<string>

default:marko

Mode de personnalisation des e-mails.

Available options:

marko,

co_branded,

white_label

email_branding_version

integer

default:1

Version de la configuration de marque des e-mails.

email_sending_domain_status

string

default:not_configured

État de validation du domaine d'expédition.

email_sending_domain

string | null

Domaine d'expédition configuré pour l'entité.

ai_enabled

boolean

default:true

Indique si les fonctions IA sont activées pour l'entité; les droits de la clé restent requis.

manual_creation_policy

ManualCreationPolicy · object

Politique de création manuelle par famille de ressources.

Show child attributes

⌘I

Lire les paramètres de l'entité

curl --request GET \
  --url https://partner-api.marko.fr/v1/settings \
  --header 'Authorization: Bearer <token>'

const url = 'https://partner-api.marko.fr/v1/settings';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://partner-api.marko.fr/v1/settings', 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://partner-api.marko.fr/v1/settings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

{
  "id": "11111111-1111-1111-1111-111111111111",
  "name": "Clubfunding",
  "type": "example",
  "mode_reporting": "trimestriel",
  "frequence_reporting": 3,
  "risk_threshold": 75,
  "portfolio_goals": {},
  "ai_enabled": true
}

{
  "type": "about:blank",
  "title": "Unauthorized",
  "status": 401,
  "detail": "A valid bearer token is required.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Forbidden",
  "status": 403,
  "detail": "The API key does not allow this operation.",
  "request_id": "req_example_partner_call"
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "type": "about:blank",
  "request_id": "<string>",
  "scope": "<string>",
  "route_id": "<string>",
  "reason_code": "<string>"
}

{
  "type": "about:blank",
  "title": "Unprocessable Content",
  "status": 422,
  "detail": "The request payload or parameters are invalid.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Too Many Requests",
  "status": 429,
  "detail": "The request rate limit was exceeded.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "An unexpected server error occurred.",
  "request_id": "req_example_partner_call"
}

Démarrer

Tutoriels

Intégrer

Référence API

Lire les paramètres de l'entité

Authorizations

Headers

Response