Comment gérer les documents dans vos BizzCardz via l’API

Il est possible de gérer des documents pdf de vos employés ou bizzcardz. Cette fonctionnalité est très pratique dans la mesure où vous pouvez joindre des documents utiles concernant l’employé. Il peut s’agir de biographie, fiche de paie ou n’importe quel autre document.

Pour manipuler ces documents, vous devez disposer d’une clé API. Vous pouvez suivre la procédure décrite sur cette page : Comment importer/exporter des données avec BizzCardz ?

Une fois votre clé API obtenue, vous pouvez effectuer les différentes actions sur les documents.

Ajout de document

L’ajout de document via l’API se fait sur ce endpoint (url) http://admin.bizzcardv2-last-eu.hidora.com/fr/api/vcard/import/[vCard ID]/document/create/ [vCard ID] représente l’id de la BizzCardz pour lequel on veut ajouter un document. Les champs à renseigner sont les mêmes que ceux via l’admin à savoir le nom, le document, la date de début et la date de fin. La date de début et la date de fin doivent être au format YYYY-MM-DD (ex: 2023-10-05). Cette requête doit être de type POST.

En supposant que l’id de la BizzCardz est 427, voilà un code exemple :

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://admin.bizzcardv2-last-eu.hidora.com/fr/api/vcard/import/427/document/create/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => /* Votre objet JSON à envoyer */,
  CURLOPT_COOKIE => "Path=%2F",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Api-Key GhyTHWgaEghy.dXr2aVN25lmkoB09urlHansyzbv2j",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

const options = {
  method: 'POST',
  url: 'https://admin.bizzcardv2-last-eu.hidora.com/fr/api/vcard/import/427/document/create/',
  headers: {
    cookie: 'Path=%2F',
    'Content-Type': 'application/json',
    Accept: 'application/json',
    Authorization: 'Api-Key GhyTHWgaEghy.dXr2aVN25lmkoB09urlHansyzbv2j'
  },
  data: /* Votre objet (renseignant les champs)*/
};

axios.request(options).then(function (response) {
  console.log(response.data);
}).catch(function (error) {
  console.error(error);
});
import requests

url = "https://admin.bizzcardv2-last-eu.hidora.com/fr/api/vcard/import/427/document/create/"

json_data= # Votre objet JSON à envoyer
headers = {
    "cookie": "Path=%2F",
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "Api-Key GhyTHWgaEghy.dXr2aVN25lmkoB09urlHansyzbv2j"
}

response = requests.request("POST", url, json=json_data, headers=headers)

print(response.text)

Si tout se passe bien, vous devez avoir un retour avec les informations du document :

{
	"id": 23,
	"document": "https://admin.bizzcardv2-last-eu.hidora.com/media/vcard/documents/bio.pdf",
	"name": "Biographie complète",
	"start_date": "2023-11-10",
	"end_date": "2024-11-10"
}

Edition de document

Editer un document via l’API se fait sur ce endpoint (url) https://admin.bizzcardv2-last-eu.hidora.com/fr/api/vcard/import/[vCard ID]/document/[Document ID]/update/ [vCard ID] représente l’id de la BizzCardz et [Document ID], l’id du document. Les champs à modifier sont les mêmes que l’ajout. Il s’agit d’une requête de type PUT.

Dans le contexte de ce tutoriel, l’id de la Bizzcardz est 427 et l’id du document est 23 en prenant en compte le retour de l’ajout du document ci-dessus.

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://admin.bizzcardv2-last-eu.hidora.com/fr/api/vcard/import/427/document/23/update/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => /* Votre objet JSON à envoyer */,
  CURLOPT_COOKIE => "Path=%2F",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Api-Key GhyTHWgaEghy.dXr2aVN25lmkoB09urlHansyzbv2j",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

Suppression de document

Vous pouvez également supprimer un document via l’API et cela se fait sur l’endpoint (url) https://admin.bizzcardv2-last-eu.hidora.com/fr/api/vcard/import/[vCard ID]/document/[Document ID]/delete/ [vCard ID] représente l’id de la BizzCardz et [Document ID], l’id du document. Cette requête est de type DELETE.

Dans le contexte de ce tutoriel, l’id de la Bizzcardz est 427 et l’id du document est 23 en prenant en compte le retour de l’ajout du document ci-dessus.

import axios from "axios";

const options = {
  method: 'PUT',
  url: 'https://admin.bizzcardv2-last-eu.hidora.com/fr/api/vcard/import/427/document/23/update/',
  headers: {
    cookie: 'Path=%2F',
    'Content-Type': 'application/json',
    Accept: 'application/json',
    Authorization: 'Api-Key GhyTHWgaEghy.dXr2aVN25lmkoB09urlHansyzbv2j'
  },
  data: /* Votre objet (renseignant les champs)*/
};

axios.request(options).then(function (response) {
  console.log(response.data);
}).catch(function (error) {
  console.error(error);
});
import requests

url = "https://admin.bizzcardv2-last-eu.hidora.com/fr/api/vcard/import/427/document/23/update/"

json_data= # Votre objet JSON à envoyer
headers = {
    "cookie": "Path=%2F",
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "Api-Key GhyTHWgaEghy.dXr2aVN25lmkoB09urlHansyzbv2j"
}

response = requests.request("PUT", url, json=json_data, headers=headers)

print(response.text)
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://admin.bizzcardv2-last-eu.hidora.com/fr/api/vcard/import/427/document/23/delete/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_POSTFIELDS => "",
  CURLOPT_COOKIE => "Path=%2F",
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Api-Key GhyTHWgaEghy.dXr2aVN25lmkoB09urlHansyzbv2j",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

const options = {
  method: 'DELETE',
  url: 'https://admin.bizzcardv2-last-eu.hidora.com/fr/api/vcard/import/427/document/23/delete/',
  headers: {
    cookie: 'Path=%2F',
    'Content-Type': 'application/json',
    Accept: 'application/json',
    Authorization: 'Api-Key GhyTHWgaEghy.dXr2aVN25lmkoB09urlHansyzbv2j'
  },
  data: ''
};

axios.request(options).then(function (response) {
  console.log(response.data);
}).catch(function (error) {
  console.error(error);
});
import requests

url = "https://admin.bizzcardv2-last-eu.hidora.com/fr/api/vcard/import/427/document/23/delete/"

json_data= ""
headers = {
    "cookie": "Path=%2F",
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "Api-Key GhyTHWgaEghy.dXr2aVN25lmkoB09urlHansyzbv2j"
}

response = requests.request("DELETE", url, json=json_data, headers=headers)

print(response.text)

Cette requête ne retourne rien en cas de succès

BizzCardz Team
AboutBizzCardz Team