13 novembre

API REST Carto-SI

Exemples de scripts d’appel aux API REST de Carto-SI

Documentation des API REST de Carto-SI

https://app.carto-si.com/apidocs/


Utiliser les API REST via cURL

Méthode 1 – via fichier et console

Remplacez le contenu des variables suivantes par les valeurs qui correspondent à votre environnement.

  • token doit contenir la clef API de votre tenant
  • tenant doit contenir l’identifiant de votre tenant
  • host doit contenir l’url d’accès à votre tenant

Vous trouverez ces valeurs dans la section API de la page Administration en vous connectant à votre environnement Carto-SI.

Sous Unix : copiez le code ci-dessous dans un fichier nommé script.sh et lancez le via un terminal.

Pour tester en ligne de commande, assurez vous des conditions de lancement et d’exécutabilité du fichier script.sh que vous aurez créé.

#!/bin/bash

# remplacez la valeur exemple ci-dessous par celle de votre token
TOKEN=`eyJ0eXAiOiJKV1IUzI1NiJ9.eyJ0ZJhcGkifQ.m0dOOo4ekUwOxJa3L1-YvNnI4D5M`

# remplacez la valeur exemple ci-dessous par celle de votre tenant
TENANT=`fdd58686-4171-de55-b897-bafd3ce0abc6`

# remplacez la valeur exemple ci-dessous par celle de votre host
HOST=`http://localhost:4200`

API="/api/v2/meta/"

URLAPI=${HOST}${API}

echo TOKEN = $TOKEN
echo TENANT = $TENANT
echo HOST = $HOST
echo API = $API
echo URLAPI = $URLAPI

echo ""
echo "---"

curl "$URLAPI" -H 'Authorization: Bearer {"token":"'"$TOKEN"'","myTenant":{"id":"'"$TENANT"'"}}' --compressed

echo ""
echo "---"


# commentaires
# aspect de la commande avec les valeurs directement dedans :
# curl 'http://localhost:4200/api/v2/meta/' -H 'Authorization: Bearer {"token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0ZW5hbnRJZCI6ImRlZmF1bHQiLCJpc3MiOiJhdXRoMCIsImV4cCI6MTYxNDE2ODAzNiwibG9naW4iOiJhZG1pbkBjYXJ0by1zaS5jb20ifQ.V8tiwGvwOmKupHsRra-Q65DAz6UdpoRsyEjcqH0tbRI","myTenant":{"id":"fdd58686-4171-de55-b897-bafd3ce0abc6"}}' --compressed

Sous Windows : copiez le code ci-dessous dans un fichier nommé script_windows.cmd et lancez le.

@echo off


rem remplacez la valeur exemple ci-dessous par celle de votre token
set /p TOKEN= "eyJ0eXAiOiJKV1IUzI1NiJ9.eyJ0ZJhcGkifQ.m0dOOo4ekUwOxJa3L1-YvNnI4D5M"

rem remplacez la valeur exemple ci-dessous par celle de votre tenant
set /p TENANT= "fdd58686-4171-de55-b897-bafd3ce0abc6"

rem remplacez la valeur exemple ci-dessous par celle de votre host
set /p HOST= "http://localhost:4200"


echo TOKEN = %TOKEN%
echo TENANT = %TENANT%
echo HOST= %HOST%


rem exemple of get all component
rem curl  -H "Authorization: Bearer {\"token\":\"%TOKEN%\", \"myTenant\":{\"id\":\"%TENANT%\"}}" -X GET %HOST%/api/v2/component --compressed



rem exemple of upload file
curl  -H "Authorization: Bearer {\"token\":\"%TOKEN%\", \"myTenant\":{\"id\":\"%TENANT%\"}}" -H "content-type: multipart/form-data;boundary=----WebKitFormBoundarydKHImlrNKBQtqAZl" -H "accept: application/json, text/plain, */*	" -F "myFile=@technical.csv" "%HOST%/api/v1/technical/upload/"  --verbose

Méthode 2 – via le navigateur

Récupérer directement une requête cURL valide et complète faite par votre navigateur web vers l’API


Annexes

Régler les soucis qu’on peut parfois rencontrer avec les guillemets https://stackoverflow.com/a/50613209

Lien vers Swagger https://app.carto-si.com/apidocs/ui/index.html


Tags:

Share:

FacebookTwitterLinkedIn

0 Commentaire