API d'ordonnancement jobshoplib
Table des matières
A quoi sert cette API ?
Comment rapidement utiliser l'API ?
Avant toute chose : token d'utilisation
Exemple au format JSON
Appel en cURL
Appel en python
Exemple au format CSV
Appel en cURL
Appel en python
Exemple au format XLSX
Appel en cURL
Appel en python
A quoi sert cette API ?
JobShopLib est une API d'ordonnancement interrogeable avec un accès limité. Pour se procurer un token d'utilisation, merci de contacter l'équipe Cross Data (support-api@crossdata.tech).
jobshoplib permet de réaliser un ordonnancement de ressources sans aucune installation logicielle nécessaire.
Pour utiliser l'API, trois éléments sont nécessaires :
Un header contenant le type de fichier envoyé et votre token d'utilisation.
Le(s) jeu(x) de données au bon format.
Un fichier de configuration envoyé sous le format de data.
Comment rapidement utiliser l'API ?
L'API a besoin de recevoir l'ensemble des ordres de fabrication afi de réaliser l'ordonnancement. Les ordres de fabrication peuvent être envoyés en plusieurs formats : JSON, Excel (
.xlsx) ou CSV. Dans le cas où vous envoyez un CSV ou XLSX le nom du fichier doit forcément êtrejob.Il faut envoyer ces données à un endpoint de l'API qui va faire le calcul. Ensuite grâce à l'id utilisateur que vous recevrez vous pourrez, en appelant le même endpoint mais avec "/job_id" en plus, récupérer les résultats.
Exemple :
Avant toute chose : token d'utilisation
Pour utiliser l'API, vous aurez besoin d'utiliser un token d'utilisation fourni par Cross Data. Pour s'en procurer un, merci de contacter l'équipe Cross Data. :warning:
Exemple au format JSON
Le format d'entrée pour les références à ordonnancer est le suivant :
Vous retrouverez ici un exemple téléchargeable.
Pour appeler l'API avec ce format, suivez les instruction ci-dessous en Python ou en cURL.
Appel en cURL
Appel en python
Exemple au format CSV
Vous retrouverez ici un exemple détaillant le format de données demandé téléchargeable.
Pour appeler l'API avec ce format, suivez les instruction ci-dessous en Python ou en cURL.
Appel en cURL
Appel en python
Exemple au format XLSX
Vous retrouverez ici un exemple détaillant le format de données demandé téléchargeable.
Pour appeler l'API avec ce format, suivez les instruction ci-dessous en Python ou en cURL.
Appel en cURL
Appel en python
Planning d'indisponibilité des machines
La contrainte d'indisponibilité des machines est disponible sur le moteur. Il suffit de renseigner les informations dans le bon format en fonction du format d'entré.
Json
Pour le format json il suffit d'ajouter une clef au fichier. La clef
planning_machines. Le format des données dans la clef machine est :Vous retrouverez ici un exemple complet de données.
Appel en python
CSV
Pour le format CSV il faut envoyer deux fichiers. Un fichier contenant les tâches, qu'il faut envoyer avec la clef
job. Un autre contenant les indisponiblités des machines, avec la clefplanning. Vous retrouverez ici un exemple détaillant le format de données pour les plannings demandé téléchargeable.Appel en cURL
Appel en python
XLSX
Pour le format XLSX il faut envoyer deux fichiers. Un fichier contenant les tâches, qu'il faut envoyer avec la clef
job. Un autre contenant les indisponiblités des machines, avec la clefplanning. Vous retrouverez ici un exemple détaillant le format de données pour les plannings demandé téléchargeable.Appel en cURL
Appel en python
Ressources Humaines
Grâce à un fichier contenant des informations à propos des opérateurs et des machines, il est possible d'instancier une notion d'affectation d'une tâche à un opérateur.
Json
Pour le format json il suffit d'ajouter une clef au fichier. La clef
operator. Le format des données dans la clef machine est :Vous retrouverez ici un exemple complet de données.
Appel en python
CSV
Pour le format CSV il faut envoyer trois fichiers. Un fichier contenant les tâches, qu'il faut envoyer avec la clef
job. Un autre contenant les indisponiblités des machines, avec la clefplanning. Et un dernier avec la clefoperator. Vous retrouverez ici un exemple détaillant le format de données pour les operateurs téléchargeable.Appel en cURL
Appel en python
XLSX
Pour le format XLSX il faut envoyer deux fichiers. Un fichier contenant les tâches, qu'il faut envoyer avec la clef
job. Un autre contenant les indisponiblités des machines, avec la clefplanning. Un autre contenant les indisponiblités des machines, avec la clefplanning. Et un dernier avec la clefoperator. Vous retrouverez ici un exemple détaillant le format de données pour les opérateurs téléchargeable.Appel en cURL
Appel en python
Planning pour les opérateurs
Comme pour les machines, il est possible de préciser des intervals où les opérateurs ne pourront pas opérer. Pour ce faire il suffit d'envoyer un autre fichier ou d'ajouter une clef au fichier json au nom "planning_operator".
Pour appeler l'API avec un planning pour les opérateurs il est nécessaire d'avoir envoyé un fichier opérateur avant.
JSON
Pour le format json il suffit d'ajouter une clef au fichier, la clef doit se présenter sous ce format :
De la même manière que précédement il suffit d'envoyer le fichier json avec les bonnes clefs au moment de la requête. Vous pouvez télécharger un exemple de fichier ici.
CSV
Pour le format CSV il sera nécessaire d'ajouter un fichier avec le nom "planning_operator", comme précédement avec "operator". Vous pouvez télécharger un fichier d'exemple de format ici.
XLSX
Pour le format XLSX il sera nécessaire d'ajouter un fichier avec le nom "planning_operator", comme précédement avec "operator". Vous pouvez télécharger un fichier d'exemple de format ici.
Fichier de configuration
Il est possible d'ajouter des paramètres pour personnaliser le calcul. Ces paramètres sont transmis à l'API via l'informatio "data", comme dans les exemple ci-dessus. Deux paramètres sont disponbiles pour le moment :
"JIT", qui signifie "just in time" qui va pénaliser les retards et les avances de positionnement des tâches. Just in time est détillé ici. Ce paramètre prends soit "TRUE" soit "FALSE" en valeur qui doivent être des chaines de caractères.
"START" qui est un paramètre qui permet de donner une date (au bon format et en chaine de caractère), cette date sera la date de début des opérations.
Appel en python