Introduction

Bienvenue dans la documentation de notre API ! Conçue pour être à la fois puissante et simple à intégrer, notre API permet d'accéder à une variété de fonctionnalités et de ressources essentielles pour vos applications. Elle repose sur des principes modernes et standardisés, offrant une expérience de développement fluide et sécurisée.

L'authentification, au cœur de notre système, garantit que seules les requêtes autorisées peuvent interagir avec l'API. Grâce à un mécanisme basé sur les clés API et le schéma Bearer Token, nous assurons la sécurité des données et des communications entre votre application et nos serveurs. Chaque requête doit inclure une clé valide, et les réponses suivent un format structuré pour faciliter l'intégration et le débogage.

Pour simplifier votre expérience, toutes les réponses, qu'il s'agisse de succès ou d'erreurs, utilisent des codes HTTP standard associés à des messages clairs et concis. De plus, des informations contextuelles sont fournies pour vous aider à résoudre rapidement les éventuels problèmes.

Enfin, notre API est conçue avec une grande attention à la fiabilité et à la transparence, vous permettant de vous concentrer sur l'intégration et l'amélioration de vos applications, tout en nous occupant de la complexité technique en arrière-plan.

Introduction à l'API

Cette documentation vous guidera dans l’utilisation efficace de notre API. Elle vous permettra de comprendre les concepts clés et de les intégrer rapidement dans vos applications.

Toutes les requêtes effectuées vers l’API nécessitent une clé API valide pour garantir la sécurité et l’authentification. Les points d’accès spécifiques aux ressources doivent être ajoutés à une base commune pour structurer vos appels.

URL principale de l'API

https://api.planiso.com

Authentification

L'authentification est une étape clé pour accéder aux ressources sécurisées de notre API. Elle permet de garantir que seules les requêtes autorisées, provenant d'applications ou d'utilisateurs légitimes, puissent interagir avec l'API. Ce mécanisme repose sur l'utilisation d'une clé API valide qui sert à identifier l'utilisateur ou l'application faisant la requête.

L'API rejettera toute tentative d'accès sans une clé valide, avec un code d'erreur approprié. Cette clé doit être incluse dans l'en-tête de chaque requête, assurant ainsi la sécurité des échanges. Elle permet ainsi de sécuriser toutes les communications entre votre application et notre API.

Récupérer la clé API

Pour obtenir votre clé API, commencez par vous connecter à notre plateforme. Par la suite, cliquez sur « Paramètres du silo » (roue dentelée), puis sélectionnez « Informations de l’organisme ». Dans le second module « Clé API Planiso », cliquez sur le crayon pour générer votre clé API.

Une fois la clé générée, vous recevrez une valeur unique qu'il faut éviter de divulguer. En cas de perte, vous devrez générer une nouvelle clé.

Pour la récupérer, il vous suffit de vous rendre dans la section «Clés API» de votre tableau de bord après votre connexion, et de générer une nouvelle clé. Vous pourrez l'utiliser pour toutes vos interactions avec l'API, en la passant dans l'en-tête Authorization de chaque requête.

Pour plus de détails sur l'utilisation de la clé API, consultez la section «Utiliser la clé API» de notre documentation.

Utiliser la clé API

Pour assurer la sécurité des communications et protéger les données sensibles, chaque requête envoyée à l'API doit inclure une clé API valide. Cette clé, qui identifie l'utilisateur ou l'application, est indispensable pour l'authentification et l'autorisation des requêtes.

La clé API doit être transmise dans l'en-tête HTTP de manière sécurisée en utilisant le schéma Bearer Token. Ce format standard garantit une validation fiable des requêtes tout en évitant l'exposition de la clé dans des endroits moins sûrs, comme les paramètres d'URL ou le corps d'une requête GET.

Le format requis pour transmettre la clé dans l'en-tête est le suivant :

Authorization: Bearer {API_KEY}

Assurez-vous de toujours remplacer {API_KEY} par la clé fournie et de ne pas exposer cette clé dans vos journaux ou dépôts de code. Une clé manquante ou incorrecte entraînera un rejet immédiat de la requête par l'API avec un code d'erreur approprié.

Exemple d'utilisation

Voici un exemple d’une requête utilisant une clé API valide pour accéder à une ressource :

curl https://api.planiso.com/v1/user \
    -X GET \
    -H "Authorization: Bearer {API_KEY}" \

Réponses standardisées

Pour une gestion optimale et un débogage efficace, notre API adopte un format de réponse standardisé, aligné avec les codes HTTP universels. Cette approche permet non seulement d’interpréter facilement le statut de chaque requête, qu’elle soit réussie ou échouée, mais aussi de comprendre rapidement la nature de la réponse. Chaque code de statut HTTP correspond à un résultat spécifique (succès ou erreur), et les messages associés fournissent des informations claires pour expliquer le résultat de la requête.

Afin de garantir une intégration fluide, toutes les réponses, qu'elles soient de succès ou d'erreur, suivent une structure uniforme. Cela permet une gestion cohérente dans votre code et vous aide à traiter les réponses de manière systématique et efficace. Ainsi, chaque réponse renvoyée par l’API contiendra trois éléments principaux :

code : Un code HTTP unique correspondant au statut de la requête. Ce code est un indicateur immédiat du résultat de la requête, qu'il s'agisse d'une réussite ou d'une erreur. Par exemple, un 200 signifie que la requête a été traitée avec succès, tandis qu’un 404 indique que la ressource demandée est introuvable.

message : Une brève explication du statut. Ce message est essentiel pour comprendre le résultat sans avoir à analyser en profondeur les réponses internes de l’API. Il offre une explication directe du succès ou de l’échec de la requête.

data : Des informations complémentaires apportant du contexte à la réponse. Cela peut inclure des détails supplémentaires pour expliquer une réussite (par exemple, les données de la ressource créée) ou des informations précises pour résoudre une erreur (comme des paramètres invalides ou des conseils pour résoudre un conflit).

Ce modèle de réponse uniforme permet aux développeurs de gérer les différentes situations rapidement et de manière fiable. Il combine simplicité pour un traitement immédiat et flexibilité pour des analyses plus approfondies si nécessaire. Ainsi, vous passez moins de temps à déboguer et plus de temps à améliorer votre application.

Exemple de réponse standardisée
{
    "code": 200,
    "message": "Request processed successfully.",
    "data": {
        "no": 123,
        "name": "New resource",
        "description": "Details of the created resource."
    }
}
Codes HTTP universels

200 OKTout a fonctionné comme prévu.

201 CreatedLa requête a été traitée avec succès et une nouvelle ressource a été créée en conséquence.

400 Bad RequestLa requête est inacceptable, souvent en raison de l'absence d'un paramètre requis.

401 UnauthorizedAucune clé API valide fournie.

402 Request FailedLes paramètres étaient valides mais la requête a échoué.

403 ForbiddenLa clé API n'a pas les permissions nécessaires pour exécuter la requête.

404 Not FoundLa ressource demandée n'existe pas.

409 ConflictLa requête entre en conflit avec une autre requête (peut-être en raison de l'utilisation de la même clé idempotente).

429 Too Many RequestsTrop de requêtes ont été envoyées à l'API en un temps trop court. Nous recommandons un recul exponentiel pour vos requêtes.

Utilisateurs

Cet objet représente un utilisateur/employé contenu dans votre silo Planiso. Utiliser pour créer, consulter, mettre à jour et supprimer des utilisateurs

Points de terminaison

GET/v1/user

GET/v1/user/{no}

POST/v1/user

PUT/v1/user/{no}

DELETE/v1/user/{no}

Liste des utilisateurs

Retourne la liste de tous les utilisateurs/employés contenu dans votre silo Planiso. Les utilisateurs sont retournés triés par date de création. Si aucun utilisateur n'est trouvé, une liste vide est retournée.

Attributs

no int
Numéro unique dans votre silo qui identifie l'utilisateur

aff_number stringUnique dans le silo. Généré par Planiso.
Numéro d'utilisateur généré automatiquement à la création par Planiso avec le préfix "PERS-". Il est unique par utilisateur. Il est utilisé pour identifier l'utilisateur dans l'application.

custom_no stringUnique dans le silo
Numéro d'utilisateur personnalisé. Il est utilisé pour identifier l'utilisateur entre Planiso et un autre système que vous utilisez.

fullname stringRequis dans Planiso
Nom et prénom de l'utilisateur

username stringUnique dans Planiso
Identifiant de connexion de l'utilisateur

email stringUnique dans Planiso
Adresse email de l'utilisateur

phone string|null
Numéro de téléphone de l'utilisateur

phonext string|null
Numéro d'extension téléphonique de l'utilisateur

cellphone string|null
Numéro de téléphone cellulaire de l'utilisateur

hired_date date|null
Date d'embauche de l'utilisateur

create_date datetimeGénéré par Planiso.
Date de la création de l'utilisateur

last_update datetimeMise à jour par Planiso
Dernière date de modification de l'utilisateur

active boolean
Indique si l'utilisateur est actif

Retours

object Un tableau associatif avec une propriété de données qui contient un tableau d'utilisateurs triés par date de création.

Point de terminaison
GET/v1/user
Demande
curl https://api.planiso.com/v1/user \
    -X GET \
    -H "Authorization: Bearer {API_KEY}" \
Réponse
{
    "code": 200,
    "message": "",
    "data": [
        {
            "no": "28",
            "aff_number": "PERS-028",
            "custom_no": "EMP-003",
            "active": true,
            "username": "usertest9",
            "fullname": "John Doe",
            "email": "johndoe@example.com",
            "phone": "+1 416-123-4567",
            "phonext": "+1 416-123-4568",
            "cellphone": "+1 416-987-6543",
            "hired_date": "2024-01-15",
            "create_date": "2024-11-27 17:01:33",
            "last_update": "2024-11-27 17:07:06"
        },
        {
            "no": "27",
            "aff_number": "PERS-027",
            "custom_no": "EMP-002",
            "active": true,
            "username": "usertest8",
            "fullname": "Jane Smith",
            "email": "janesmith@example.com",
            "phone": "+1 514-234-5678",
            "phonext": "+1 514-234-5679",
            "cellphone": "+1 514-876-5432",
            "hired_date": "2023-06-10",
            "create_date": "2024-11-27 17:01:01",
            "last_update": "2024-11-27 17:02:00"
        },
        {
            "no": "26",
            "aff_number": "PERS-026",
            "custom_no": "EMP-001",
            "active": true,
            "username": "usertest7",
            "fullname": "Emily Johnson",
            "email": "emilyjohnson@example.com",
            "phone": "+1 403-345-6789",
            "phonext": "+1 403-345-6790",
            "cellphone": "+1 403-987-6543",
            "hired_date": "2022-03-25",
            "create_date": "2024-11-27 17:00:40",
            "last_update": "2024-11-27 17:01:10"
        }
    ]
}
Réponses d'erreur spécifiques

401 Unauthorized Aucune clé API valide fournie

403 Forbidden La clé API n'a pas les permissions nécessaires pour exécuter la requête

500 Internal Server Error Une erreur interne du serveur s'est produite

Trouver un utilisateur

Retourne les informations de l'utilisateurs/employés dont le numéro {no} est fourni. Si aucun utilisateur n'est trouvé, le code 400 et un tableau vide sont retournés.

Attributs

no int
Numéro unique dans votre silo qui identifie l'utilisateur

aff_number stringUnique dans le silo. Généré par Planiso.
Numéro d'utilisateur généré automatiquement à la création par Planiso avec le préfix "PERS-". Il est unique par utilisateur. Il est utilisé pour identifier l'utilisateur dans l'application.

custom_no stringUnique dans le silo
Numéro d'utilisateur personnalisé. Il est utilisé pour identifier l'utilisateur entre Planiso et un autre système que vous utilisez. Exemple : numéro de personnel, numéro de contrat, etc.

fullname stringRequis dans Planiso
Nom et prénom de l'utilisateur

username stringUnique dans Planiso
Identifiant de connexion de l'utilisateur

email stringUnique dans Planiso
Adresse email de l'utilisateur

phone string|null
Numéro de téléphone de l'utilisateur

phonext string|null
Numéro d'extension téléphonique de l'utilisateur

cellphone string|null
Numéro de téléphone cellulaire de l'utilisateur

hired_date date|null
Date d'embauche de l'utilisateur

create_date datetimeGénéré par Planiso.
Date de la création de l'utilisateur

last_update datetimeMise à jour par Planiso
Dernière date de modification de l'utilisateur

active boolean
Indique si l'utilisateur est actif

Retours

object Un tableau associatif avec une propriété de données qui contient un tableau d'attributs sur l'utilisateur qui correspondant au numéro {no} fourni.

Point de terminaison
GET/v1/user/{no}
Demande
curl https://api.planiso.com/v1/user/{no} \
    -X GET \
    -H "Authorization: Bearer {API_KEY}" \
Réponse
{
    "code": 200,
    "message": "user found",
    "data": {
        "no": "1",
        "aff_number": "PERS-001",
        "custom_no": "",
        "active": true,
        "username": "jdoe",
        "fullname": "John Doe",
        "email": "john.doe@example.com",
        "phone": "123-456-7890",
        "phonext": "101",
        "cellphone": "987-654-3210",
        "hired_date": "2023-06-01",
        "create_date": "2024-11-20 10:15:30",
        "last_update": "2024-11-22 15:00:00"
    }
}
Réponses d'erreur spécifiques

404 Not Found La ressource demandée {no} n'existe pas

401 Unauthorized Aucune clé API valide fournie

403 Forbidden La clé API n'a pas les permissions nécessaires pour exécuter la requête

500 Internal Server Error Une erreur interne du serveur s'est produite

Création d'un utilisateur

Dans Planiso, la création d'un utilisateur via l'API se fait sans attribuer de mot de passe. Cette méthode permet d'ajouter un utilisateur au système avec les informations essentielles, mais sans lui donner directement accès à l'application. Si un utilisateur doit se connecter, un responsable silo devra se connecter à l'application Planiso, accéder au menu Utilisateurs, générer un mot de passe, et attribuer les privilèges nécessaires à cet utilisateur. Ces fonctionnalités ne sont pas disponibles via l'API pour des raisons de sécurité et de gestion des accès.

Attributs

no int
Numéro unique dans votre silo qui identifie l'utilisateur

aff_number stringUnique dans le silo. Généré par Planiso.
Numéro d'utilisateur généré automatiquement à la création par Planiso avec le préfix "PERS-". Il est unique par utilisateur. Il est utilisé pour identifier l'utilisateur dans l'application.

custom_no stringUnique dans le silo
Numéro d'utilisateur personnalisé. Il est utilisé pour identifier l'utilisateur entre Planiso et un autre système que vous utilisez. Exemple : numéro de personnel, numéro de contrat, etc.

fullname stringRequis dans Planiso
Nom et prénom de l'utilisateur

username stringUnique dans Planiso
Identifiant de connexion de l'utilisateur

email stringUnique dans Planiso
Adresse email de l'utilisateur

phone string|null
Numéro de téléphone de l'utilisateur

phonext string|null
Numéro d'extension téléphonique de l'utilisateur

cellphone string|null
Numéro de téléphone cellulaire de l'utilisateur

hired_date date|null
Date d'embauche de l'utilisateur

create_date datetimeGénéré par Planiso.
Date de la création de l'utilisateur

last_update datetimeMise à jour par Planiso
Dernière date de modification de l'utilisateur

active boolean
Indique si l'utilisateur est actif

Retours

object Un array associatif contenant une propriété de données qui contient un tableau d'attributs sur l'utilisateur qui correspondant à l'utilisateur créé.

Point de terminaison
POST/v1/user
Demande
curl https://api.planiso.com/v1/user \
    -X POST \
    -H "Authorization: Bearer {API_KEY}" \
    -d "custom_no=EMP-004" \
    -d "fullname=Steve Jobs" \
    -d "username=stevejobs" \
    -d "email=stevejobs@example.cpm" \
    -d "phone=418-123-1234" \
    -d "phonext=104" \
    -d "cellphone=418-321-4321" \
    -d "hired_date=2024-11-27" \
    -d "active=1"
Réponse
{
    "code": 201,
    "message": "user inserted successfully",
    "data": {
        "no": 29,
        "aff_number": "PERS-029",
        "custom_no": "EMP-004",
        "username": "stevejobs",
        "fullname": "Steve Jobs",
        "hired_date": "2024-11-27",
        "phone": "418-123-1234",
        "phonext": "104",
        "cellphone": "418-321-4321",
        "email": "stevejobs@example.com"
    }
}
Réponses d'erreur spécifiques

400 Bad Request Un ou plusieurs champs requis sont manquants dans la requête. Probablement le nom complet {fullname}

401 Unauthorized Aucune clé API valide fournie

403 Forbidden La clé API n'a pas les permissions nécessaires pour exécuter la requête

409 Conflict La requête entre en conflit avec une autre requête, probablement en raison d'un conflit de clé unique déjà existante, comme le courriel {email} ou le nom d'utilisateur {username}.

500 Internal Server Error Une erreur interne du serveur s'est produite

Modification d'un utilisateur

Cette méthode permet de modifier les informations d'un utilisateur existant dans Planiso.

Attributs

custom_no stringUnique dans le silo
Numéro d'utilisateur personnalisé. Il est utilisé pour identifier l'utilisateur entre Planiso et un autre système que vous utilisez. Exemple : numéro de personnel, numéro de contrat, etc.

fullname stringRequis dans Planiso
Nom et prénom de l'utilisateur

username stringUnique dans Planiso
Identifiant de connexion de l'utilisateur

email stringUnique dans Planiso
Adresse email de l'utilisateur

phone string|null
Numéro de téléphone de l'utilisateur

phonext string|null
Numéro d'extension téléphonique de l'utilisateur

cellphone string|null
Numéro de téléphone cellulaire de l'utilisateur

hired_date date|null
Date d'embauche de l'utilisateur

active boolean
Indique si l'utilisateur est actif

Retours

object Un array associatif contenant une propriété de données qui contient un tableau des attributs qui ont été modifiés sur l'utilisateur dont le numéro {no} est fourni.

Point de terminaison
PUT/v1/user/{no}
Demande
curl https://api.planiso.com/v1/user/{no} \
    -X PUT \
    -H "Authorization: Bearer {API_KEY}" \
    -d "custom_no=EMP-004" \
    -d "fullname=Steve Jobs" \
    -d "username=stevejobs" \
    -d "email=stevejobs-2@example.cpm" \
    -d "phone=418-123-1235" \
    -d "phonext=105" \
    -d "cellphone=418-321-4322"
Réponse
{
    "code": 200,
    "message": "User updated successfully",
    "data": {
        "custom_no": "EMP-004",
        "fullname": "Steve Jobs",
        "username": "stevejobs",
        "email": "stevejobs-2@example.com",
        "phone": "418-123-1235",
        "phonext": "105",
        "cellphone": "418-321-4322",
        "last_update": "2024-11-27 18:30:36",
        "no": 29
    }
}
Réponses d'erreur spécifiques

400 Bad Request Un ou plusieurs champs requis sont manquants ou ont un mauvais format, ou des champs fournis sont invalides. {fullname} ne peut être null, {hired_date} n'a pas le bon format, etc.

401 Unauthorized Aucune clé API valide fournie

403 Forbidden La clé API n'a pas les permissions nécessaires pour exécuter la requête

404 Not Found L'utilisateur n'existe pas

409 Conflict La requête entre en conflit avec une autre requête, probablement en raison d'un conflit de clé unique déjà existante, comme le courriel {email}, le numéro personnalisé {custom_num} ou le nom d'utilisateur {username}.

500 Internal Server Error Une erreur interne du serveur s'est produite

Supprimer un utilisateur

Cette méthode permet de désactiver un utilisateur existant dans Planiso.

Attributs
Retours

object Un array vide.

Point de terminaison
DELETE/v1/user/{no}
Demande
curl https://api.planiso.com/v1/user/{no} \
    -X DELETE \
    -H "Authorization: Bearer {API_KEY}" \
Réponse
{
    "code": 204,
    "message": "user deleted successfully",
    "data": []
}
Réponses d'erreur spécifiques

401 Unauthorized Aucune clé API valide fournie

403 Forbidden La clé API n'a pas les permissions nécessaires pour exécuter la requête

404 Not Found L'utilisateur n'existe pas

500 Internal Server Error Une erreur interne du serveur s'est produite

Clients

Cet objet représente un fournisseur contenu dans votre silo Planiso. Utiliser pour créer, consulter, mettre à jour et supprimer des fournisseurs. Un fournisseur est lié à l'objet Organisation.

Points de terminaison

GET/v1/customer

GET/v1/customer/{no}

POST/v1/customer

PUT/v1/customer/{no}

DELETE/v1/customer/{no}

Liste des clients

Retourne la liste de tous les clients contenu dans votre silo Planiso. Un clients est lié à l'objet Organisation.Les clients sont retournés triés par date de création. Si aucun client n'est trouvé, une liste vide est retournée.

Attributs

no int
Numéro unique dans votre silo qui identifie le client

aff_number string
Numéro du client généré automatiquement à la création par Planiso avec le préfix "FOU-". Il est utilisé pour identifier le client dans l'application.

custom_no string
Numéro de client personnalisé. Il est utilisé pour identifier le client entre Planiso et un autre système que vous utilisez.

active boolean
Indique si le client est actif

organization array
Un tableau associatif avec une propriété de données qui contient les attributs de l'oraganisation lié à ce client.

Retours

object Un tableau associatif avec une propriété de données qui contient un tableau de clients triés par date d'ajout.

Point de terminaison
GET/v1/customer
Demande
curl https://api.planiso.com/v1/customer \
    -X GET \
    -H "Authorization: Bearer {API_KEY}" \
Réponse
{
    "code": 200,
    "message": "",
    "data": [
        {
            "no": "8",
            "aff_number": "CLI-008",
            "custom_no": "",
            "active": true,
            "date_added": "2024-11-27 17:43:56",
            "organization": {
                "aff_number": "PART-061",
                "no": "61",
                "name": "Tech Innovations Inc.",
                "adress": "456 Innovation Way",
                "city": "Montreal",
                "province": "QC",
                "country": "Canada",
                "phone": "514-555-1000",
                "toll_free": "800-555-1001",
                "phone_extension": "101",
                "fax": "514-555-2000",
                "postal_code": "H3Z 2Y7",
                "email": "contact@techinnovations.com",
                "website": "https:\/\/techinnovations.com",
                "active": true
            }
        },
        {
            "no": "7",
            "aff_number": "CLI-007",
            "custom_no": "cus-019",
            "active": true,
            "date_added": "2024-11-27 16:05:45",
            "organization": {
                "aff_number": "PART-052",
                "no": "52",
                "name": "Creative Solutions Ltd.",
                "adress": "789 Design Avenue",
                "city": "Quebec City",
                "province": "QC",
                "country": "Canada",
                "phone": "418-555-1234",
                "toll_free": "800-555-4321",
                "phone_extension": "102",
                "fax": "418-555-5678",
                "postal_code": "G1R 1X3",
                "email": "info@creativesolutions.com",
                "website": "https:\/\/creativesolutions.com",
                "active": true
            }
        },
        {
            "no": "6",
            "aff_number": "CLI-006",
            "custom_no": "Custum-test-010",
            "active": true,
            "date_added": "2024-11-26 15:52:32",
            "organization": {
                "aff_number": "PART-034",
                "no": "34",
                "name": "Global Tech Enterprises",
                "adress": "101 Global Blvd",
                "city": "Toronto",
                "province": "ON",
                "country": "Canada",
                "phone": "416-555-9876",
                "toll_free": "800-555-7654",
                "phone_extension": "103",
                "fax": "416-555-4321",
                "postal_code": "M5A 1A1",
                "email": "contact@globaltech.com",
                "website": "https:\/\/globaltech.com",
                "active": true
            }
        }
    ]
}
Réponses d'erreur spécifiques

401 Unauthorized Aucune clé API valide fournie

403 Forbidden La clé API n'a pas les permissions nécessaires pour exécuter la requête

500 Internal Server Error Une erreur interne du serveur s'est produite

Trouver un client

Retourne les informations du fclient dont le numéro {no} est fourni. Si aucun client n'est trouvée, un tableau vide sont retournés.

Attributs

no int
Numéro unique dans votre silo qui identifie le client

aff_number string
Numéro du client généré automatiquement à la création par Planiso avec le préfix "FOU-". Il est utilisé pour identifier le client dans l'application.

custom_no string
Numéro de client personnalisé. Il est utilisé pour identifier le client entre Planiso et un autre système que vous utilisez.

active boolean
Indique si le client est actif

organization array
Un tableau associatif avec une propriété de données qui contient les attributs de l'oraganisation lié à ce client.

Retours

object Un tableau associatif avec une propriété de données qui contient un tableau d'attributs sur le client qui correspondant au numéro {no} fourni.

Point de terminaison
GET/v1/customer/{no}
Demande
curl https://api.planiso.com/v1/customer/{no} \
    -X GET \
    -H "Authorization: Bearer {API_KEY}" \
Réponse
{
    "code": 200,
    "message": "Customer found",
    "data": {
        "no": "8",
        "aff_number": "CLI-008",
        "custom_no": "",
        "active": true,
        "organization": {
            "aff_number": "PART-065",
            "no": "65",
            "name": "Tech Innovations Inc.",
            "adress": "456 Innovation Way",
            "city": "Montreal",
            "province": "QC",
            "country": "Canada",
            "phone": "514-555-1000",
            "toll_free": "800-555-1001",
            "phone_extension": "101",
            "fax": "514-555-2000",
            "postal_code": "H3Z 2Y7",
            "email": "contact@techinnovations.com",
            "website": "https:\/\/techinnovations.com",
            "active": true
        }
    }
}
Réponses d'erreur spécifiques

404 Not Found Le client {no} n'existe pas

401 Unauthorized Aucune clé API valide fournie

403 Forbidden La clé API n'a pas les permissions nécessaires pour exécuter la requête

500 Internal Server Error Une erreur interne du serveur s'est produite

Créer un client

Créer un client et retourne un tableau associatif avec une propriété de données qui contient un tableau d'attributs sur le nouveau client.

Attributs

no int
Numéro unique dans votre silo qui identifie le client

aff_number string
Numéro du client généré automatiquement à la création par Planiso avec le préfix "FOU-". Il est utilisé pour identifier le client dans l'application.

custom_no string
Numéro de client personnalisé. Il est utilisé pour identifier le client entre Planiso et un autre système que vous utilisez.

active boolean
Indique si le client est actif

organization array
Un tableau associatif avec une propriété de données qui contient les attributs de l'oraganisation lié à ce client.

Retours

object Un tableau associatif avec une propriété de données qui contient les attributs du client qui a été ajouté.

Point de terminaison
POST/v1/customer
Demande
curl https://api.planiso.com/v1/customer \
    -X POST \
    -H "Authorization: Bearer {API_KEY}" \
    -d "custom_no=CUST-0009" \
    -d "organization_name=Inovatech Radio Machin Inc." \
    -d "organization_adress=456 Industry Road" \
    -d "organization_city=Montreal" \
    -d "organization_province=QC" \
    -d "organization_country=Canada" \
    -d "organization_phone=514-321-1234" \
    -d "organization_toll_free=800-888-1234" \
    -d "organization_phone_extension=101" \
    -d "organization_fax=514-321-4321" \
    -d "organization_postal_code=H3Z 2Y7" \
    -d "organization_email=info@inovatechradiomachin.com" \
    -d "organization_website=https://inovatechradiomachin.com"
Réponse
{
    "code": 201,
    "message": "customer inserted successfully",
    "data": {
        "no": 10,
        "aff_number": "CLI-010",
        "custom_no": "CUST-0009",
        "active": true,
        "organization": {
            "no": 66,
            "aff_number": "PART-066",
            "name": "Inovatech Radio Machin Inc.",
            "adress": "456 Industry Road",
            "city": "Montreal",
            "province": "QC",
            "country": "Canada",
            "phone": "514-321-1234",
            "toll_free": "800-888-1234",
            "phone_extension": "101",
            "fax": "514-321-4321",
            "postal_code": "H3Z 2Y7",
            "website": "https:\/\/inovatechradiomachin.com",
            "email": "info@inovatechradiomachin.com",
            "active": true
        }
    }
}
Réponses d'erreur spécifiques

400 Bad Request Un ou plusieurs champs requis sont manquants ou ont un mauvais format, ou des champs fournis sont invalides.

401 Unauthorized Aucune clé API valide fournie

403 Forbidden La clé API n'a pas les permissions nécessaires pour exécuter la requête

409 Conflict Le client {custom_no} existe déjà, {organization_name} existe déjà

500 Internal Server Error Une erreur interne du serveur s'est produite

Modifier un client

Cette méthode permet de modifier un client existant dans Planiso. Pour modifier les informations de l'organisation lié à un client, utiliser Modifier une organisation.

Attributs

no int
Numéro unique dans votre silo qui identifie le client

aff_number string
Numéro du client généré automatiquement à la création par Planiso avec le préfix "FOU-". Il est utilisé pour identifier le client dans l'application.

custom_no string
Numéro de client personnalisé. Il est utilisé pour identifier le client entre Planiso et un autre système que vous utilisez.

active boolean
Indique si le client est actif

organization array
Un tableau associatif avec une propriété de données qui contient les attributs de l'oraganisation lié à ce client.

Retours

object Un array associatif contenant une propriété de données qui contient un tableau des attributs qui ont été modifiés sur le client dont le numéro {no} est fourni.

Point de terminaison
PUT/v1/customer/{no}
Demande
curl https://api.planiso.com/v1/customer/{no} \
    -X PUT \
    -H "Authorization: Bearer {API_KEY}" \
    -d "custom_no=CUST-00010"
Réponse
{
    "code": 200,
    "message": "Customer updated successfully",
    "data": {
        "custom_no": "CUST-00010",
        "no": 10
    }
}
Réponses d'erreur spécifiques

400 Bad Request Un ou plusieurs champs requis sont manquants ou ont un mauvais format, ou des champs fournis sont invalides.

401 Unauthorized Aucune clé API valide fournie

403 Forbidden La clé API n'a pas les permissions nécessaires pour exécuter la requête

409 Conflict Le client {custom_no} existe déjà

500 Internal Server Error Une erreur interne du serveur s'est produite

Supprimer un client

Cette méthode permet de désactiver un client existant dans Planiso. Il n'est pas possible de désactiver l'organisation liée, pour ce faire suivre la procédure de suppression d'une organisation.

Attributs

no int
Numéro unique dans votre silo qui identifie le client

aff_number string
Numéro du client généré automatiquement à la création par Planiso avec le préfix "FOU-". Il est utilisé pour identifier le client dans l'application.

custom_no string
Numéro de client personnalisé. Il est utilisé pour identifier le client entre Planiso et un autre système que vous utilisez.

active boolean
Indique si le client est actif

organization array
Un tableau associatif avec une propriété de données qui contient les attributs de l'oraganisation lié à ce client.

Retours

object Un array vide

Point de terminaison
DELETE/v1/customer
Demande
curl https://api.planiso.com/v1/customer \
    -X DELETE \
    -H "Authorization: Bearer {API_KEY}" \
Réponse
{
    "code": 200,
    "message": "Customer deleted successfully",
    "data": []
}
Réponses d'erreur spécifiques

401 Unauthorized Aucune clé API valide fournie

403 Forbidden La clé API n'a pas les permissions necessaires pour exécuter la requête

404 Not Found Le client n'existe pas

500 Internal Server Error Une erreur interne du serveur s'est produite

Fournisseurs

Cet objet représente un fournisseur contenu dans votre silo Planiso. Utiliser pour créer, consulter, mettre à jour et supprimer des fournisseurs. Un fournisseur est lié à l'objet Organisation.

Points de terminaison

GET/v1/supplier

GET/v1/supplier/{no}

POST/v1/supplier

PUT/v1/supplier/{no}

DELETE/v1/supplier/{no}

Liste des fournisseurs

Retourne la liste de tous les fournisseurs contenu dans votre silo Planiso. Un fournisseur est lié à l'objet Organisation. Les fournisseurs sont retournés triés par date de création. Si aucun fournisseur n'est trouvé, une liste vide est retournée.

Attributs

no int
Numéro unique dans votre silo qui identifie le fournisseur

aff_number string
Numéro du fournisseur généré automatiquement à la création par Planiso avec le préfix "FOU-". Il est utilisé pour identifier le fournisseur dans l'application.

custom_no string
Numéro de fournisseur personnalisé. Il est utilisé pour identifier le fournisseur entre Planiso et un autre système que vous utilisez.

is_14001 boolean
Indique si le fournisseur est certifié ISO 14001

is_18001 boolean
Indique si le fournisseur est certifié ISO 18001

is_9001 boolean
Indique si le fournisseur est certifié ISO 9001

active boolean
Indique si le fournisseur est actif

organization array
Un tableau associatif avec une propriété de données qui contient un les attributs de l'oraganisation lié à ce fournisseur.

Retours

object Un tableau associatif avec une propriété de données qui contient un tableau de fournisseurs triés par date d'ajout.

Point de terminaison
GET/v1/supplier
Demande
curl https://api.planiso.com/v1/supplier \
    -X GET \
    -H "Authorization: Bearer {API_KEY}" \
Réponse
{
    "code": 200,
    "message": "",
    "data": [
        {
            "no": "22",
            "aff_number": "FOU-22",
            "custom_no": "test-012",
            "active": false,
            "is_14001": false,
            "is_18001": false,
            "is_9001": false,
            "organization": {
                "aff_number": "PART-032",
                "no": "32",
                "name": "Tech Innovators Inc.",
                "adress": "56 rue parcel",
                "city": "Paris",
                "province": "Île-de-France",
                "country": "France",
                "phone": "01-234-5678",
                "toll_free": "",
                "phone_extension": "",
                "fax": "",
                "postal_code": "75000",
                "email": "contact@techinnovators.com",
                "website": "https:\/\/techinnovators.com",
                "active": true
            }
        },
        {
            "no": "21",
            "aff_number": "FOU-21",
            "custom_no": "test-011",
            "active": true,
            "is_14001": false,
            "is_18001": false,
            "is_9001": false,
            "organization": {
                "aff_number": "PART-034",
                "no": "34",
                "name": "Global Solutions Ltd.",
                "adress": "789 Global Road",
                "city": "Berlin",
                "province": "Berlin",
                "country": "Germany",
                "phone": "030-123456",
                "toll_free": "",
                "phone_extension": "",
                "fax": "",
                "postal_code": "10115",
                "email": "info@globalsolutions.de",
                "website": "https:\/\/globalsolutions.de",
                "active": true
            }
        },
        {
            "no": "20",
            "aff_number": "FOU-20",
            "custom_no": "ORG-212",
            "active": true,
            "is_14001": true,
            "is_18001": false,
            "is_9001": true,
            "organization": {
                "aff_number": "PART-025",
                "no": "25",
                "name": "Test Supplier Inc.",
                "adress": "456 Supplier Ave 1",
                "city": "Supplier City 1",
                "province": "Supplier Province 1",
                "country": "Supplier Country 1",
                "phone": "234-567-8901",
                "toll_free": "800-234-5678",
                "phone_extension": "202",
                "fax": "252-363-5656",
                "postal_code": "54321",
                "email": "supplier@webologic.com",
                "website": "http:\/\/supplier.com",
                "active": true
            }
        }
    ]
}
Réponses d'erreur spécifiques

401 Unauthorized Aucune clé API valide fournie

403 Forbidden Aucune clé API valide fournie

500 Internal Server Error Erreur interne du serveur

Trouver une fournisseur

Retourne les informations du fournisseur dont le numéro {no} est fourni. Si aucune fournisseur n'est trouvée, le code 400 et un tableau vide sont retournés.

Attributs

no int
Numéro unique dans votre silo qui identifie le fournisseur

aff_number string
Numéro du fournisseur généré automatiquement à la création par Planiso avec le préfix "FOU-". Il est utilisé pour identifier le fournisseur dans l'application.

custom_no string
Numéro de fournisseur personnalisé. Il est utilisé pour identifier le fournisseur entre Planiso et un autre système que vous utilisez.

is_14001 boolean
Indique si le fournisseur est certifié ISO 14001

is_18001 boolean
Indique si le fournisseur est certifié ISO 18001

is_9001 boolean
Indique si le fournisseur est certifié ISO 9001

active boolean
Indique si le fournisseur est actif

organization array
Un tableau associatif avec une propriété de données qui contient un les attributs de l'oraganisation lié à ce fournisseur.

Retours

object Un tableau associatif avec une propriété de données qui contient un tableau d'attributs sur le fournisseur qui correspondant au numéro {no} fourni.

Point de terminaison
GET/v1/supplier/{no}
Demande
curl https://api.planiso.com/v1/supplier/{no} \
    -X GET \
    -H "Authorization: Bearer {API_KEY}" \
Réponse
{
    "code": 200,
    "message": "Supplier found",
    "data": {
        "no": "20",
        "aff_number": "FOU-20",
        "custom_no": "ORG-212",
        "active": true,
        "is_14001": true,
        "is_18001": false,
        "is_9001": true,
        "organization": {
            "aff_number": "PART-025",
            "no": "25",
            "name": "Test Supplier Inc.",
            "adress": "456 Supplier Ave 1",
            "city": "Supplier City 1",
            "province": "Supplier Province 1",
            "country": "Supplier Country 1",
            "phone": "234-567-8901",
            "toll_free": "800-234-5678",
            "phone_extension": "202",
            "fax": "252-363-5656",
            "postal_code": "54321",
            "email": "supplier@webologic.com",
            "website": "http:\/\/supplier.com",
            "active": true
        }
    }
}
Réponses d'erreur spécifiques

401 Unauthorized Aucune clé API valide fournie

403 Forbidden Aucune clé API valide fournie

404 Not Found Le sous-contractant {no} n'existe pas

500 Internal Server Error Erreur interne du serveur

Créer un fournisseur

Créer un fournisseur et retourne un tableau associatif avec une propriété de données qui contient un tableau d'attributs sur le nouveau fournisseur.

Attributs

no int
Numéro unique dans votre silo qui identifie le fournisseur

aff_number string
Numéro du fournisseur généré automatiquement à la création par Planiso avec le préfix "FOU-". Il est utilisé pour identifier le fournisseur dans l'application.

custom_no string
Numéro de fournisseur personnalisé. Il est utilisé pour identifier le fournisseur entre Planiso et un autre système que vous utilisez.

is_14001 boolean
Indique si le fournisseur est certifié ISO 14001

is_18001 boolean
Indique si le fournisseur est certifié ISO 18001

is_9001 boolean
Indique si le fournisseur est certifié ISO 9001

active boolean
Indique si le fournisseur est actif

organization array
Un tableau associatif avec une propriété de données qui contient les attributs de l'oraganisation lié à ce fournisseur.

Retours

object Un tableau associatif avec une propriété de données qui contient les attributs du fournisseur qui a été ajouté.

Point de terminaison
POST/v1/supplier
Demande
curl https://api.planiso.com/v1/supplier \
    -X POST \
    -H "Authorization: Bearer {API_KEY}" \
    -d "custom_no=supplier-011" \
    -d "is_14001=" \
    -d "is_18001=" \
    -d "is_9001=" \
    -d "organization_name=Tech Solutions Inc." \
    -d "organization_adress=123 Tech Street" \
    -d "organization_city=Montreal" \
    -d "organization_province=QC" \
    -d "organization_country=Canada" \
    -d "organization_phone=514-555-1000" \
    -d "organization_toll_free=800-555-1001" \
    -d "organization_phone_extension=101" \
    -d "organization_fax=514-555-2000" \
    -d "organization_postal_code=H3Z 2Y7" \
    -d "organization_email=contact@techsolutions.com" \
    -d "organization_website=https://techsolutions.com"
Réponse
{
    "code": 201,
    "message": "Supplier created successfully",
    "data": {
        "no": "23",
        "aff_number": "FOU-23",
        "custom_no": "supplier-011",
        "active": true,
        "is_14001": false,
        "is_18001": false,
        "is_9001": false,
        "organization": {
            "aff_number": "PART-040",
            "no": "40",
            "name": "Tech Solutions Inc.",
            "adress": "123 Tech Street",
            "city": "Montreal",
            "province": "QC",
            "country": "Canada",
            "phone": "514-555-1000",
            "toll_free": "800-555-1001",
            "phone_extension": "101",
            "fax": "514-555-2000",
            "postal_code": "H3Z 2Y7",
            "email": "contact@techsolutions.com",
            "website": "https:\/\/techsolutions.com",
            "active": true
        }
    }
}
Réponses d'erreur spécifiques

400 Bad Request Le fournisseur {custom_no} n'est pas valide, {organization_name} est manquant, {organization_adress} est manquant, etc

401 Unauthorized Aucune clé API valide fournie

403 Forbidden Aucune clé API valide fournie

409 Conflict Le fournisseur {custom_no} existe déjà

500 Internal Server Error Erreur interne du serveur

Modifier un fournisseur

Cette méthode permet de modifier un fournisseur existant dans Planiso. Pour modifier les informations de l'organisation lié à un fournisseur, utiliser Modifier une organisation.

Attributs

no int
Numéro unique dans votre silo qui identifie le fournisseur

aff_number string
Numéro du fournisseur généré automatiquement à la création par Planiso avec le préfix "FOU-". Il est utilisé pour identifier le fournisseur dans l'application.

custom_no string
Numéro de fournisseur personnalisé. Il est utilisé pour identifier le fournisseur entre Planiso et un autre système que vous utilisez.

is_14001 boolean
Indique si le fournisseur est certifié ISO 14001

is_18001 boolean
Indique si le fournisseur est certifié ISO 18001

is_9001 boolean
Indique si le fournisseur est certifié ISO 9001

active boolean
Indique si le fournisseur est actif

organization array
Un tableau associatif avec une propriété de données qui contient les attributs de l'oraganisation lié à ce fournisseur.

Retours

object Un array associatif contenant une propriété de données qui contient un tableau des attributs qui ont été modifiés sur le fournisseur dont le numéro {no} est fourni.

Point de terminaison
PUT/v1/supplier/{no}
Demande
curl https://api.planiso.com/v1/supplier/{no} \
    -X PUT \
    -H "Authorization: Bearer {API_KEY}" \
    -d "is_14001=1" \
    -d "is_18001=1" \
    -d "is_9001=1" \
    -d "custom_num=supplier-edit-011"
Réponse
{
    "code": 200,
    "message": "Supplier updated successfully",
    "data": {
        "custom_no": "supplier-edit-011",
        "is_14001": true,
        "is_18001": true,
        "is_9001": true,
        "no": 23
    }
}
Réponses d'erreur spécifiques

401 Unauthorized Aucune clé API valide fournie

403 Forbidden Aucune clé API valide fournie

409 Conflict Le fournisseur {custom_no} existe deja

500 Internal Server Error Erreur interne du serveur

Supprimer un fournisseur

Cette méthode permet de désactiver un fournisseur existant dans Planiso. Il n'est pas possible de désactiver l'organisation liée, pour ce faire suivre la procédure de suppression d'une organisation.

Attributs

no int
Numéro unique dans votre silo qui identifie le fournisseur

aff_number string
Numéro du fournisseur généré automatiquement à la création par Planiso avec le préfix "FOU-". Il est utilisé pour identifier le fournisseur dans l'application.

custom_no string
Numéro de fournisseur personnalisé. Il est utilisé pour identifier le fournisseur entre Planiso et un autre système que vous utilisez.

is_14001 boolean
Indique si le fournisseur est certifié ISO 14001

is_18001 boolean
Indique si le fournisseur est certifié ISO 18001

is_9001 boolean
Indique si le fournisseur est certifié ISO 9001

active boolean
Indique si le fournisseur est actif

organization array
Un tableau associatif avec une propriété de données qui contient les attributs de l'oraganisation lié à ce fournisseur.

Retours

object Un array vide

Point de terminaison
DELETE/v1/supplier
Demande
curl https://api.planiso.com/v1/supplier \
    -X DELETE \
    -H "Authorization: Bearer {API_KEY}" \
Réponse
{
    "code": 200,
    "message": "Supplier deleted successfully",
    "data": []
}
Réponses d'erreur spécifiques

401 Unauthorized Aucune clé API valide fournie

403 Forbidden La clé API n'a pas les permissions necessaires pour exécuter la requête

404 Not Found Le fournisseur n'existe pas

500 Internal Server Error Une erreur interne du serveur s'est produite

Sous-contracteurs

Cet objet représente un sous-contractant contenu dans votre silo Planiso. Utiliser pour créer, consulter, mettre à jour et supprimer des sous-contractants. Un sous-contractant est lié à l'objet Organisations.

Points de terminaison

GET/v1/subcontractor

GET/v1/subcontractor/{no}

POST/v1/subcontractor

PUT/v1/subcontractor/{no}

DELETE/v1/subcontractor/{no}

Liste des sous-contractants

Retourne la liste de tous les sous-contractants contenu dans votre silo Planiso. Les sous-contractants sont retournés triés par date de création. Si aucun sous-contractant n'est trouvé, une liste vide est retournée.

Attributs

no int
Numéro unique dans votre silo qui identifie le sous-contractant

aff_number string
Numéro du sous-contractant généré automatiquement à la création par Planiso avec le préfix "ST-". Il est utilisé pour identifier le sous-contractant dans l'application.

custom_no string|null
Numéro de sous-contacteur personnalisé. Il est utilisé pour identifier le sous-contacteur entre Planiso et un autre système que vous utilisez.

active boolean
Indique si le sous-contractant est actif

organization array
Un tableau associatif avec une propriété de données qui contient un les attributs de l'oraganisation lié à ce sous-contractant.

Retours

object Un tableau associatif avec une propriété de données qui contient un tableau de sous-contractants triés par date d'ajout.

Point de terminaison
GET/v1/subcontractor
Demande
curl https://api.planiso.com/v1/subcontractor \
    -X GET \
    -H "Authorization: Bearer {API_KEY}" \
Réponse
{
    "code": 200,
    "message": "",
    "data": [
        {
            "no": "1",
            "aff_number": "ST-001",
            "custom_no": "subcontractor-001",
            "active": true,
            "date_added": "2024-11-26 10:00:00",
            "organization": {
                "aff_number": "PART-001",
                "no": "1",
                "name": "Tech Solutions Inc.",
                "adress": "123 Tech Street",
                "city": "Montreal",
                "province": "QC",
                "country": "Canada",
                "phone": "514-555-1000",
                "toll_free": "800-555-1001",
                "phone_extension": "101",
                "fax": "514-555-2000",
                "postal_code": "H3Z 2Y7",
                "email": "contact@techsolutions.com",
                "website": "https:\/\/techsolutions.com",
                "active": true
            }
        },
        {
            "no": "2",
            "aff_number": "ST-002",
            "custom_no": "subcontractor-002",
            "active": true,
            "date_added": "2024-11-26 10:10:00",
            "organization": {
                "aff_number": "PART-002",
                "no": "2",
                "name": "Creative Designs Ltd.",
                "adress": "456 Art Avenue",
                "city": "Quebec City",
                "province": "QC",
                "country": "Canada",
                "phone": "418-555-2000",
                "toll_free": "800-555-2001",
                "phone_extension": "102",
                "fax": "418-555-3000",
                "postal_code": "G1R 3V8",
                "email": "info@creativedesigns.ca",
                "website": "https:\/\/creativedesigns.ca",
                "active": true
            }
        },
        {
            "no": "3",
            "aff_number": "ST-003",
            "custom_no": "subcontractor-003",
            "active": false,
            "date_added": "2024-11-26 10:15:00",
            "organization": {
                "aff_number": "PART-003",
                "no": "3",
                "name": "Advanced Consulting Group",
                "adress": "789 Business Rd",
                "city": "Toronto",
                "province": "ON",
                "country": "Canada",
                "phone": "416-555-3000",
                "toll_free": "800-555-3001",
                "phone_extension": "103",
                "fax": "416-555-4000",
                "postal_code": "M5V 2N8",
                "email": "contact@advconsulting.com",
                "website": "https:\/\/advconsulting.com",
                "active": false
            }
        },
        {
            "no": "4",
            "aff_number": "ST-004",
            "custom_no": "subcontractor-004",
            "active": true,
            "date_added": "2024-11-26 10:20:00",
            "organization": {
                "aff_number": "PART-004",
                "no": "4",
                "name": "Global Marketing Partners",
                "adress": "123 Global Parkway",
                "city": "Vancouver",
                "province": "BC",
                "country": "Canada",
                "phone": "604-555-4000",
                "toll_free": "800-555-4001",
                "phone_extension": "104",
                "fax": "604-555-5000",
                "postal_code": "V6B 5L5",
                "email": "info@globalmarketing.com",
                "website": "https:\/\/globalmarketing.com",
                "active": true
            }
        }
    ]
}
Réponses d'erreur spécifiques

401 Unauthorized Aucune clé API valide fournie

403 Forbidden Aucune clé API valide fournie

500 Internal Server Error Erreur interne du serveur

Trouver un sous-contractant

Retourne les informations du sous-contractant dont le numéro {no} est fourni. Si aucune sous-contractant n'est trouvée, le code 400 et un tableau vide sont retournés.

Attributs

no int
Numéro unique dans votre silo qui identifie le sous-contractant

aff_number string
Numéro du sous-contractant généré automatiquement à la création par Planiso avec le préfix "ST-". Il est utilisé pour identifier le sous-contractant dans l'application.

custom_no string|null
Numéro de sous-contacteur personnalisé. Il est utilisé pour identifier le sous-contacteur entre Planiso et un autre système que vous utilisez.

active boolean
Indique si le sous-contractant est actif

organization array
Un tableau associatif avec une propriété de données qui contient un les attributs de l'oraganisation lié à ce sous-contractant.

Retours

object Un tableau associatif avec une propriété de données qui contient un tableau d'attributs sur le sous-contractant qui correspondant au numéro {no} fourni.

Point de terminaison
GET/v1/subcontractor/{no}
Demande
curl https://api.planiso.com/v1/subcontractor/{no} \
    -X GET \
    -H "Authorization: Bearer {API_KEY}" \
Réponse
{
    "code": 200,
    "message": "Subcontractor found",
    "data": {
        "no": "1",
        "aff_number": "ST-001",
        "custom_no": "subcontractor-001",
        "active": true,
        "organization": {
            "aff_number": "PART-001",
            "no": "1",
            "name": "Tech Solutions Inc.",
            "adress": "123 Tech Street",
            "city": "Montreal",
            "province": "QC",
            "country": "Canada",
            "phone": "514-555-1000",
            "toll_free": "800-555-1001",
            "phone_extension": "101",
            "fax": "514-555-2000",
            "postal_code": "H3Z 2Y7",
            "email": "contact@techsolutions.com",
            "website": "https:\/\/techsolutions.com",
            "active": true
        }
    }
}
Réponses d'erreur spécifiques

404 Not Found Le sous-contractant {no} n'existe pas

401 Unauthorized Aucune clé API valide fournie

403 Forbidden Aucune clé API valide fournie

500 Internal Server Error Erreur interne du serveur

Créer un sous-contractant

Créer un sous-contractant et retourne un tableau associatif avec une propriété de données qui contient un tableau d'attributs sur le nouveau sous-contractant.

Attributs

no int
Numéro unique dans votre silo qui identifie le sous-contractant

aff_number string
Numéro du sous-contractant généré automatiquement à la création par Planiso avec le préfix "ST-". Il est utilisé pour identifier le sous-contractant dans l'application.

custom_no string|null
Numéro de sous-contacteur personnalisé. Il est utilisé pour identifier le sous-contacteur entre Planiso et un autre système que vous utilisez.

active boolean
Indique si le sous-contractant est actif

organization array
Un tableau associatif avec une propriété de données qui contient un les attributs de l'oraganisation lié à ce sous-contractant.

Retours

object Un tableau associatif avec une propriété de données qui contient un les attributs du sous-contractant qui a été ajouté.

Point de terminaison
POST/v1/subcontractor
Demande
curl https://api.planiso.com/v1/subcontractor \
    -X POST \
    -H "Authorization: Bearer {API_KEY}" \
    -d "custom_no=subcontractor-005" \
    -d "organization_name=Tech Solutions Inc." \
    -d "organization_adress=123 Tech Street" \
    -d "organization_city=Montreal" \
    -d "organization_province=QC" \
    -d "organization_country=Canada" \
    -d "organization_phone=514-555-1000" \
    -d "organization_toll_free=800-555-1001" \
    -d "organization_phone_extension=101" \
    -d "organization_fax=514-555-2000" \
    -d "organization_postal_code=H3Z 2Y7" \
    -d "organization_email=contact@techsolutions.com" \
    -d "organization_website=https://techsolutions.com"
Réponse
{
    "code": 201,
    "message": "subcontractor inserted successfully",
    "data": {
        "no": 7,
        "aff_number": "ST-007",
        "custom_no": "subcontractor-005",
        "organization": {
            "aff_number": "PART-039",
            "no": "39",
            "name": "Tech Solutions Inc.",
            "adress": "123 Tech Street",
            "city": "Montreal",
            "province": "QC",
            "country": "Canada",
            "phone": "514-555-1000",
            "toll_free": "800-555-1001",
            "phone_extension": "101",
            "fax": "514-555-2000",
            "postal_code": "H3Z 2Y7",
            "email": "contact@techsolutions.com",
            "website": "https:\/\/techsolutions.com",
            "active": "1"
        }
    }
}
Réponses d'erreur spécifiques

400 Bad Request Le sous-contractant {custom_no} n'est pas valide, {organization_name} est manquant, {organization_adress} est manquant, etc

404 Not Found Le sous-contractant {no} n'existe pas

401 Unauthorized Aucune clé API valide fournie

403 Forbidden Aucune clé API valide fournie

500 Internal Server Error Erreur interne du serveur

Modifier un sous-contractant

Cette méthode permet de modifier un sous-contractant existant dans Planiso. Pour modifier les informations de l'organisation lié à un sous-contractant, utiliser Modifier une organisation.

Attributs

no int
Numéro unique dans votre silo qui identifie le sous-contractant

aff_number string
Numéro du sous-contractant généré automatiquement à la création par Planiso avec le préfix "ST-". Il est utilisé pour identifier le sous-contractant dans l'application.

custom_no string|null
Numéro de sous-contacteur personnalisé. Il est utilisé pour identifier le sous-contacteur entre Planiso et un autre système que vous utilisez.

active boolean
Indique si le sous-contractant est actif

organization array
Un tableau associatif avec une propriété de données qui contient un les attributs de l'oraganisation lié à ce sous-contractant.

Retours

object Un array associatif contenant une propriété de données qui contient un tableau des attributs qui ont été modifiés sur le sous-contractant dont le numéro {no} est fourni.

Point de terminaison
PUT/v1/subcontractor/{no}
Demande
curl https://api.planiso.com/v1/subcontractor/{no} \
    -X PUT \
    -H "Authorization: Bearer {API_KEY}" \
    -d "custom_no=sub-005"
Réponse
{
    "code": 200,
    "message": "SubContractor updated successfully",
    "data": {
        "custom_no": "sub-005",
        "no": 7
    }
}
Réponses d'erreur spécifiques

404 Not Found Le sous-contractant {no} n'existe pas

401 Unauthorized Aucune clé API valide fournie

403 Forbidden Aucune clé API valide fournie

500 Internal Server Error Erreur interne du serveur

Supprimer un sous-contractant

Cette méthode permet de désactiver un sous-contractant existant dans Planiso. Il n'est pas possible de désactiver l'organisation liée, pour ce faire suivre la procédure de suppression d'une organisation.

Attributs

no int
Numéro unique dans votre silo qui identifie le sous-contractant

aff_number string
Numéro du sous-contractant généré automatiquement à la création par Planiso avec le préfix "ST-". Il est utilisé pour identifier le sous-contractant dans l'application.

custom_no string|null
Numéro de sous-contacteur personnalisé. Il est utilisé pour identifier le sous-contacteur entre Planiso et un autre système que vous utilisez.

active boolean
Indique si le sous-contractant est actif

organization array
Un tableau associatif avec une propriété de données qui contient un les attributs de l'oraganisation lié à ce sous-contractant.

Retours

object Un array vide

Point de terminaison
DELETE/v1/subcontractor/{no}
Demande
curl https://api.planiso.com/v1/subcontractor/{no} \
    -X DELETE \
    -H "Authorization: Bearer {API_KEY}" \
Réponse
{
    "code": 200,
    "message": "Subcontractor deleted successfully",
    "data": []
}
Réponses d'erreur spécifiques

404 Not Found Le sous-contractant {no} n'existe pas

401 Unauthorized Aucune clé API valide fournie

403 Forbidden Aucune clé API valide fournie

500 Internal Server Error Erreur interne du serveur

Organisations (Parties interessées)

Cet objet représente une organisation contenu dans votre silo Planiso. L'organisation est un fournisseur, un sous-contractant, un client. Utiliser pour créer, consulter, mettre à jour et supprimer des organisations.

Points de terminaison

GET/v1/organization

GET/v1/organization/{no}

POST/v1/organization

PUT/v1/organization/{no}

DELETE/v1/organization/{no}

Liste des organisations

Retourne la liste de toutes les organisations contenu dans votre silo Planiso. Les organisations sont retournés triées par date de création. Si aucune organisation n'est trouvée, une liste vide est retournée.

Attributs

no int
Numéro unique dans votre silo qui identifie l'organisation

aff_number string
Numéro d'organisation généré automatiquement à la création par Planiso avec le préfix "PART-". Il est utilisé pour identifier l'organisation dans l'application.

name stringUnique dans votre silo. Requis pour créer une organisation dans Planiso
Nom de l'organisation

adress stringRequis pour créer une organisation dans Planiso
Adresse physique de l'organisation (no civic, rue/route/boulvard etc)

city string|null
Ville de l'organisation

country string|null
Pays de l'organisation

postal_code string|null
Code postal de l'organisation

phone string|null
Numéro de téléphone de l'organisation

email string|null
Adresse email de l'organisation

website string|null
Site web de l'organisation

active boolean
Indique si l'organisation est active

Retours

object Un tableau associatif avec une propriété de données qui contient un tableau d'oganisations triées par date d'ajout.

Point de terminaison
GET/v1/organization
Demande
curl https://api.planiso.com/v1/organization \
    -X GET \
    -H "Authorization: Bearer {API_KEY}" \
Réponse
{
    "code": 200,
    "message": "",
    "data": [
        {
            "no": "36",
            "aff_number": "PART-036",
            "name": "Supermarché Central",
            "adress": "123 Boulevard des Marchands",
            "city": "Québec",
            "province": "QC",
            "country": "Canada",
            "phone": "418-123-4567",
            "toll_free": "800-555-1234",
            "phone_extension": "101",
            "fax": "418-123-9876",
            "postal_code": "G1A1A1",
            "email": "contact@supercentral.ca",
            "website": "https:\/\/supercentral.ca",
            "active": true
        },
        {
            "no": "35",
            "aff_number": "PART-035",
            "name": "Tech Solutions",
            "adress": "789 Rue des Technologies",
            "city": "Montréal",
            "province": "QC",
            "country": "Canada",
            "phone": "514-987-6543",
            "toll_free": "800-666-7890",
            "phone_extension": "202",
            "fax": "514-987-1234",
            "postal_code": "H2Z1A1",
            "email": "support@techsolutions.ca",
            "website": "https:\/\/techsolutions.ca",
            "active": true
        },
        {
            "no": "34",
            "aff_number": "PART-034",
            "name": "Boulangerie Delice",
            "adress": "321 Rue des Pains",
            "city": "Sherbrooke",
            "province": "QC",
            "country": "Canada",
            "phone": "819-555-4321",
            "toll_free": "800-777-6543",
            "phone_extension": "303",
            "fax": "819-555-9876",
            "postal_code": "J1H2A3",
            "email": "info@boulangeriedelice.ca",
            "website": "https:\/\/boulangeriedelice.ca",
            "active": true
        },
        {
            "no": "33",
            "aff_number": "PART-033",
            "name": "Garage AutoPro",
            "adress": "456 Avenue des Mécaniciens",
            "city": "Trois-Rivières",
            "province": "QC",
            "country": "Canada",
            "phone": "819-333-1234",
            "toll_free": "800-888-4321",
            "phone_extension": "404",
            "fax": "819-333-8765",
            "postal_code": "G9A4A5",
            "email": "service@autopro.ca",
            "website": "https:\/\/autopro.ca",
            "active": true
        }
    ]
}
Réponses d'erreur spécifiques

401 Unauthorized Aucune clé API valide fournie

403 Forbidden Aucune clé API valide fournie

500 Internal Server Error Erreur interne du serveur

Trouver une organisation

Retourne les informations de l'organisation dont le numéro {no} est fourni. Si aucune organisation n'est trouvée, le code 400 et un tableau vide sont retournés.

Attributs

no int
Numéro unique dans votre silo qui identifie l'organisation

aff_number string
Numéro d'organisation généré automatiquement à la création par Planiso avec le préfix "PART-". Il est utilisé pour identifier l'organisation dans l'application.

name stringUnique dans votre silo. Requis pour créer une organisation dans Planiso
Nom de l'organisation

adress stringRequis pour créer une organisation dans Planiso
Adresse physique de l'organisation (no civic, rue/route/boulvard etc)

city string|null
Ville de l'organisation

country string|null
Pays de l'organisation

postal_code string|null
Code postal de l'organisation

phone string|null
Numéro de téléphone de l'organisation

email string|null
Adresse email de l'organisation

website string|null
Site web de l'organisation

active boolean
Indique si l'organisation est active

Retours

object Un tableau associatif avec une propriété de données qui contient un tableau d'attributs sur l'organisation qui correspondant au numéro {no} fourni.

Point de terminaison
GET/v1/organization/{no}
Demande
curl https://api.planiso.com/v1/organization/{no} \
    -X GET \
    -H "Authorization: Bearer {API_KEY}" \
Réponse
{
    "code": 200,
    "message": "organization found",
    "data": {
        "aff_number": "PART-036",
        "no": "36",
        "name": "Supermarché Central",
        "adress": "123 Boulevard des Marchands",
        "city": "Québec",
        "province": "QC",
        "country": "Canada",
        "phone": "418-123-4567",
        "toll_free": "800-555-1234",
        "phone_extension": "101",
        "fax": "418-123-9876",
        "postal_code": "G1A1A1",
        "email": "contact@supercentral.ca",
        "website": "https:\/\/supercentral.ca",
        "active": true
    }
}
Réponses d'erreur spécifiques

404 Not Found L'organisation {no} n'existe pas

401 Unauthorized Aucune clé API valide fournie

403 Forbidden Aucune clé API valide fournie

500 Internal Server Error Erreur interne du serveur

Créer une organisation

Cette méthode est utilisé pour ajouter une nouvelle organisation.

Attributs

no int
Numéro unique dans votre silo qui identifie l'organisation

aff_number string
Numéro d'organisation généré automatiquement à la création par Planiso avec le préfix "PART-". Il est utilisé pour identifier l'organisation dans l'application.

name stringUnique dans votre silo. Requis pour créer une organisation dans Planiso
Nom de l'organisation

adress stringRequis pour créer une organisation dans Planiso
Adresse physique de l'organisation (no civic, rue/route/boulvard etc)

city string|null
Ville de l'organisation

country string|null
Pays de l'organisation

postal_code string|null
Code postal de l'organisation

phone string|null
Numéro de téléphone de l'organisation

email string|null
Adresse email de l'organisation

website string|null
Site web de l'organisation

active boolean
Indique si l'organisation est active

Retours

object Un tableau associatif avec une propriété de données qui contient un les attributs dde l'organisation qui a été ajouté.

Point de terminaison
POST/v1/organization
Demande
curl https://api.planiso.com/v1/organization \
    -X POST \
    -H "Authorization: Bearer {API_KEY}" \
    -d "name=Super Central Inc." \
    -d "adress=450 Avenue des Lumières" \
    -d "city=Montréal" \
    -d "country=Canada" \
    -d "postal_code=H2Y3Y3" \
    -d "phone=514-555-1234" \
    -d "phone_extension=202" \
    -d "fax=514-555-5678" \
    -d "toll_free=1-800-555-9000" \
    -d "email=info@supercentral.ca" \
    -d "website=https://supercentral.ca"
Réponse
{
    "code": 201,
    "message": "organization inserted successfully",
    "data": {
        "aff_number": "PART-038",
        "no": "37",
        "name": "Super Central Inc.",
        "adress": "450 Avenue des Lumières",
        "city": "Montréal",
        "province": "QC",
        "country": "Canada",
        "phone": "514-555-1234",
        "toll_free": "1-800-555-9000",
        "phone_extension": "202",
        "fax": "514-555-5678",
        "postal_code": "H2Y3Y3",
        "email": "info@supercentral.ca",
        "website": "https:\/\/supercentral.ca",
        "active": true
    }
}
Réponses d'erreur spécifiques

400 Bad Request Un ou plusieurs champs requis sont manquants ou ont un mauvais format, ou des champs fournis sont invalides. Probablement name ou adress

401 Unauthorized Aucune clé API valide fournie

403 Forbidden Aucune clé API valide fournie

409 Conflict L'organisation {name} existe déjà

500 Internal Server Error Erreur interne du serveur

Modifier une ogranisation

Cette méthode permet de modifier une organisation existante dans Planiso.

Attributs

no int
Numéro unique dans votre silo qui identifie l'organisation

aff_number string
Numéro d'organisation généré automatiquement à la création par Planiso avec le préfix "PART-". Il est utilisé pour identifier l'organisation dans l'application.

name stringUnique dans votre silo. Requis pour créer une organisation dans Planiso
Nom de l'organisation

adress stringRequis pour créer une organisation dans Planiso
Adresse physique de l'organisation (no civic, rue/route/boulvard etc)

city string|null
Ville de l'organisation

country string|null
Pays de l'organisation

postal_code string|null
Code postal de l'organisation

phone string|null
Numéro de téléphone de l'organisation

email string|null
Adresse email de l'organisation

website string|null
Site web de l'organisation

active boolean
Indique si l'organisation est active

Retours

object Un array associatif contenant une propriété de données qui contient un tableau des attributs qui ont été modifiés sur l'organisation dont le numéro {no} est fourni.

Point de terminaison
PUT/v1/organization/{no}
Demande
curl https://api.planiso.com/v1/organization/{no} \
    -X PUT \
    -H "Authorization: Bearer {API_KEY}" \
    -d "name=Super Central Music Inc." \
    -d "adress=450 Avenue des Arcs en Lumières" \
    -d "city=Montréal Sud" \
    -d "country=Canada" \
    -d "postal_code=H2Y3Y3" \
    -d "phone=514-555-1234" \
    -d "phone_extension=202" \
    -d "fax=514-555-5678" \
    -d "toll_free=1-800-555-9000" \
    -d "email=info@supercentral.ca" \
    -d "website=https://supercentral.ca"
Réponse
{
    "code": 200,
    "message": "Organization updated successfully",
    "data": {
        "name": "Super Central Music Inc.",
        "adress": "450 Avenue des Arcs en Lumières",
        "city": "Montréal Sud",
        "country": "Canada",
        "postal_code": "H2Y3Y3",
        "phone": "514-555-1234",
        "phone_extension": "202",
        "fax": "514-555-5678",
        "toll_free": "1-800-555-9000",
        "email": "info@supercentral.ca",
        "website": "https:\/\/supercentral.ca",
        "last_update": "2024-11-26 18:52:40",
        "no": 38
    }
}
Réponses d'erreur spécifiques

400 Bad Request Un ou plusieurs champs requis sont manquants ou ont un mauvais format, ou des champs fournis sont invalides. Probablement name ou adress

401 Unauthorized Aucune clé API valide fournie

403 Forbidden Aucune clé API valide fournie

404 Not Found L'organisation {no} n'existe pas

409 Conflict L'organisation {name} existe déjà

500 Internal Server Error Erreur interne du serveur

Supprimer une organisation

Cette méthode permet de désactiver une organisation existante dans Planiso. Si cette organisation est liée à un client, un sous-constractant ou un fournisseur, ce dernier ne ser pas désactiver. Suivre la procédure de suppression d'un client, d'un sous-constractant ou d'un fournisseur.

Attributs

no int
Numéro unique dans votre silo qui identifie l'organisation

aff_number string
Numéro d'organisation généré automatiquement à la création par Planiso avec le préfix "PART-". Il est utilisé pour identifier l'organisation dans l'application.

name stringUnique dans votre silo. Requis pour créer une organisation dans Planiso
Nom de l'organisation

adress stringRequis pour créer une organisation dans Planiso
Adresse physique de l'organisation (no civic, rue/route/boulvard etc)

city string|null
Ville de l'organisation

country string|null
Pays de l'organisation

postal_code string|null
Code postal de l'organisation

phone string|null
Numéro de téléphone de l'organisation

email string|null
Adresse email de l'organisation

website string|null
Site web de l'organisation

active boolean
Indique si l'organisation est active

Retours

object Un array vide

Point de terminaison
DELETE/v1/organization/{no}
Demande
curl https://api.planiso.com/v1/organization/{no} \
    -X DELETE \
    -H "Authorization: Bearer {API_KEY}" \
Réponse
{
    "code": 200,
    "message": "Organization deleted successfully",
    "data": []
}
Réponses d'erreur spécifiques

401 Unauthorized Aucune clé API valide fournie

403 Forbidden Aucune clé API valide fournie

404 Not Found L'organisation {no} n'existe pas

500 Internal Server Error Une erreur interne du serveur est survenue.

Projets

Cet objet représente un projet contenu dans votre silo Planiso. Utiliser pour créer, consulter, mettre à jour et supprimer des projets.

Points de terminaison

GET/v1/project

GET/v1/project/{no}

POST/v1/project

PUT/v1/project/{no}

DELETE/v1/project/{no}

Liste des projets

Retourne la liste de tous les projets contenu dans votre silo Planiso. Les projets sont retournés triés par date de création. Si aucun projet n'est trouvé, une liste vide est retournée.

Attributs

no int
Numéro unique dans votre silo qui identifie le projet

aff_number string
Numéro de projet généré automatiquement à la création par Planiso avec le préfix "PROJ-". Il est unique par projet. Il est utilisé pour identifier le projet dans l'application.

custom_no string|null
Numéro de projet personnalisé. Il est utilisé pour identifier le projet entre Planiso et un autre système que vous utilisez.

name stringRequis pour créer un projet dans Planiso
Nom du projet

location string|null
Emplacement du projet

start_date string|nullLa date de début doit être au format Y-m-d
Date de début du projet

end_date string|nullLa date de fin doit être au format Y-m-d
Date de fin du projet

active boolean
Indique si le projet est actif

Retours

object Un tableau associatif avec une propriété de données qui contient un tableau de projet triés par date de début de projet.

Point de terminaison
GET/v1/project
Demande
curl https://api.planiso.com/v1/project \
    -X GET \
    -H "Authorization: Bearer {API_KEY}" \
Réponse
{
    "code": 200,
    "message": "",
    "data": [
        {
            "no": "1",
            "aff_number": "PROJ-001",
            "custom_no": "PR-0001",
            "name": "Construction Centre Sportif",
            "location": "Montréal",
            "start_date": "2024-01-10",
            "end_date": "2024-12-15",
            "active": true
        },
        {
            "no": "2",
            "aff_number": "PROJ-002",
            "custom_no": "PR-0002",
            "name": "Rénovation École Secondaire",
            "location": "Québec",
            "start_date": "2024-02-01",
            "end_date": "2024-06-30",
            "active": true
        },
        {
            "no": "3",
            "aff_number": "PROJ-003",
            "custom_no": "PR-0003",
            "name": "Développement Quartier Résidentiel",
            "location": "Laval",
            "start_date": "2024-03-15",
            "end_date": null,
            "active": true
        },
        {
            "no": "4",
            "aff_number": "PROJ-004",
            "custom_no": null,
            "name": "Réhabilitation Pont Routier",
            "location": "Trois-Rivières",
            "start_date": "2024-04-01",
            "end_date": "2024-09-01",
            "active": true
        },
        {
            "no": "5",
            "aff_number": "PROJ-005",
            "custom_no": null,
            "name": "Aménagement Parc Urbain",
            "location": "Sherbrooke",
            "start_date": "2024-05-20",
            "end_date": "2024-11-30",
            "active": true
        }
    ]
}
Réponses d'erreur spécifiques

401 Unauthorized Aucune clé API valide fournie

403 Forbidden Aucune clé API valide fournie

500 Internal Server Error Erreur interne du serveur

Trouver un projet

Retourne les informations du projet dont le numéro {no} est fourni. Si aucun projet n'est trouvé, le code 400 et un tableau vide sont retournés.

Attributs

no int
Numéro unique dans votre silo qui identifie le projet

aff_number string
Numéro de projet généré automatiquement à la création par Planiso avec le préfix "PROJ-". Il est unique par projet. Il est utilisé pour identifier le projet dans l'application.

custom_no string|null
Numéro de projet personnalisé. Il est utilisé pour identifier le projet entre Planiso et un autre système que vous utilisez.

name stringRequis pour créer un projet dans Planiso
Nom du projet

location string|null
Emplacement du projet

start_date string|nullLa date de début doit être au format Y-m-d
Date de début du projet

end_date string|nullLa date de fin doit être au format Y-m-d
Date de fin du projet

active boolean
Indique si le projet est actif

Retours

object Un tableau associatif avec une propriété de données qui contient un les attributs du projet qui correspondant au numéro {no} fourni.

Point de terminaison
GET/v1/project/{no}
Demande
curl https://api.planiso.com/v1/project/{no} \
    -X GET \
    -H "Authorization: Bearer {API_KEY}" \
Réponse
{
    "code": 200,
    "message": "Project found",
    "data": {
        "no": "8",
        "aff_number": "PROJ-008",
        "custom_no": "PR-0008",
        "name": "Construction Salle de Spectacle",
        "location": "Gatineau",
        "start_date": "2024-06-15",
        "end_date": "2024-12-01",
        "active": true
    }
}
Réponses d'erreur spécifiques

404 Not Found Le projet {no} n'existe pas

401 Unauthorized Aucune clé API valide fournie

403 Forbidden Aucune clé API valide fournie

500 Internal Server Error Erreur interne du serveur

Créer un projet

Cette méthode permet d'ajouter un nouveau projet dans Planiso.

Attributs

no int
Numéro unique dans votre silo qui identifie le projet

aff_number string
Numéro de projet généré automatiquement à la création par Planiso avec le préfix "PROJ-". Il est unique par projet. Il est utilisé pour identifier le projet dans l'application.

custom_no string|null
Numéro de projet personnalisé. Il est utilisé pour identifier le projet entre Planiso et un autre système que vous utilisez.

name stringRequis pour créer un projet dans Planiso
Nom du projet

location string|null
Emplacement du projet

start_date string|nullLa date de début doit être au format Y-m-d
Date de début du projet

end_date string|nullLa date de fin doit être au format Y-m-d
Date de fin du projet

active boolean
Indique si le projet est actif

Retours

object Un tableau associatif avec une propriété de données qui contient un les attributs du projet qui a été ajouté.

Point de terminaison
POST/v1/project
Demande
curl https://api.planiso.com/v1/project \
    -X POST \
    -H "Authorization: Bearer {API_KEY}" \
    -d "custom_no=PR_102" \
    -d "name=Développement logiciel" \
    -d "location=Montréal" \
    -d "start_date=2024-01-10" \
    -d "end_date=2027-08-02"
Réponse
{
    "code": 201,
    "message": "project inserted successfully",
    "data": {
        "no": 37,
        "aff_number": "PROJ-037",
        "custom_no": "PR_102",
        "name": "Développement logiciel",
        "location": "Montréal",
        "start_date": "2024-01-10",
        "end_date": "2027-08-02",
        "active": true
    }
}
Réponses d'erreur spécifiques

400 Bad Request Un ou plusieurs champs requis sont manquants ou ont un mauvais format, ou des champs fournis sont invalides. Probablement que le champs {name} est vide.

401 Unauthorized Aucune clé API valide fournie

403 Forbidden Aucune clé API valide fournie

409 Conflict Le projet {custom_no} existe déjà

500 Internal Server Error Erreur interne du serveur

Modifier un projet

Cette méthode permet de modifier un projet existant dans Planiso.

Attributs

no int
Numéro unique dans votre silo qui identifie le projet

aff_number string
Numéro de projet généré automatiquement à la création par Planiso avec le préfix "PROJ-". Il est unique par projet. Il est utilisé pour identifier le projet dans l'application.

custom_no string|null
Numéro de projet personnalisé. Il est utilisé pour identifier le projet entre Planiso et un autre système que vous utilisez.

name stringRequis pour créer un projet dans Planiso
Nom du projet

location string|null
Emplacement du projet

start_date string|nullLa date de début doit être au format Y-m-d
Date de début du projet

end_date string|nullLa date de fin doit être au format Y-m-d
Date de fin du projet

active boolean
Indique si le projet est actif

Retours

object Un array associatif contenant une propriété de données qui contient un tableau des attributs qui ont été modifiés sur le projet dont le numéro {no} est fourni.

Point de terminaison
PUT/v1/project/{no}
Demande
curl https://api.planiso.com/v1/project/{no} \
    -X PUT \
    -H "Authorization: Bearer {API_KEY}" \
    -d "custom_no=PR_103" \
    -d "name=Développement Logiciel Beta" \
    -d "location=Montréal Nord" \
    -d "start_date=2024-01-05" \
    -d "end_date=2028-08-02"
Réponse
{
    "code": 200,
    "message": "Project updated successfully",
    "data": {
        "custom_no": "PR_103",
        "name": "Développement Logiciel Beta",
        "location": "Montréal Nord",
        "start_date": "2024-01-05",
        "end_date": "2028-08-02",
        "active": true,
        "last_update": "2024-11-26 17:43:27",
        "no": 8
    }
}
Réponses d'erreur spécifiques

400 Bad Request Un ou plusieurs champs requis sont manquants ou ont un mauvais format, ou des champs fournis sont invalides.

401 Unauthorized Aucune clé API valide fournie

403 Forbidden La clé API n'a pas les permissions nécessaires pour exécuter la requête

404 Not Found Le projet {no} n'existe pas

409 Conflict Le projet {custom_no} existe déjà

500 Internal Server Error Une erreur interne du serveur s'est produite

Supprimer un projet

Cette méthode permet de désactiver un projet existant dans Planiso.

Attributs

no int
Numéro unique dans votre silo qui identifie le projet

aff_number string
Numéro de projet généré automatiquement à la création par Planiso avec le préfix "PROJ-". Il est unique par projet. Il est utilisé pour identifier le projet dans l'application.

custom_no string|null
Numéro de projet personnalisé. Il est utilisé pour identifier le projet entre Planiso et un autre système que vous utilisez.

name stringRequis pour créer un projet dans Planiso
Nom du projet

location string|null
Emplacement du projet

start_date string|nullLa date de début doit être au format Y-m-d
Date de début du projet

end_date string|nullLa date de fin doit être au format Y-m-d
Date de fin du projet

active boolean
Indique si le projet est actif

Retours

object Un array vide.

Point de terminaison
DELETE/v1/project/{no}
Demande
curl https://api.planiso.com/v1/project/{no} \
    -X DELETE \
    -H "Authorization: Bearer {API_KEY}" \
Réponse
{
    "code": 200,
    "message": "Poject deleted successfully",
    "data": []
}
Réponses d'erreur spécifiques

400 Bad Request Un ou plusieurs champs requis sont manquants ou ont un mauvais format, ou des champs fournis sont invalides.

401 Unauthorized Aucune clé API valide fournie

403 Forbidden Aucune clé API valide fournie

404 Not Found Le projet {no} n'existe pas

500 Internal Server Error Une erreur interne du serveur est survenue.

Équipements

Cet objet représente un équipement contenu dans votre silo Planiso. Utiliser pour ajouter, consulter, mettre à jour et supprimer des équipements. Un équipement est lié à l'objet Types d'équipement.

Points de terminaison

GET/v1/equipment

GET/v1/equipement/{no}

POST/v1/equipment

PUT/v1/equipment/{no}

DELETE/v1/equipment/{no}

Liste des équipements

Retourne la liste de tous les équipements contenu dans votre silo Planiso. Les équipements sont retournés triés par date d'ajout. Si aucun équipement n'est trouvé, une liste vide est retournée.

Attributs

no int
Numéro de l'équipement unique dans votre silo. Identifiant de l'équipement.

aff_number stringUnique dans le silo. Généré par Planiso.
Numéro d'équipement généré automatiquement à la création par Planiso avec le préfix "EQ-". Il est unique par équipement dans votre silo. Il est utilisé pour identifier l'équipement dans l'application.

num_equip stringRequis pour créer un équipement dans Planiso
Numéro ou nom personnalisé de l'équipement

year int|nullDoit être supérieur à 1900 et inférieur ou égale à l'année actuelle
Année de fabrication de l'équipement

brand nameRequis dans pour création un équipement dans Planiso
Marque de l'équipement

nummodel string|null
Numéro de modèle de l'équipement

numserial string|null
Numéro de série de l'équipement.

purchase_date string|nullLe format de la date des achats acceptée par l'API est Y-m-d
Date d'achat de l'équipement

purchase_seller string|null
Représente le vendeur de l'équipement à qui l'équipement a été acheté.

active boolean
Indique si l'équipement est actif ou non.

type array
Tableau des types d'équipements liés à l'équipement contenant les attributs suivants : no, type_name, active.

Retours

object Un tableau associatif avec une propriété de données qui contient un tableau d'équipements triés par date d'ajout'.

Point de terminaison
GET/v1/equipment
Demande
curl https://api.planiso.com/v1/equipment \
    -X GET \
    -H "Authorization: Bearer {API_KEY}" \
Réponse
{
    "code": 200,
    "message": "",
    "data": [
        {
            "no": "2",
            "aff_number": "EQ-002",
            "num_equip": "CAM-2023-001",
            "year": "2023",
            "brand": "Toyota",
            "nummodel": "Hiace",
            "numserial": "SNTOYOTA12345",
            "purchase_date": "2023-06-15",
            "purchase_seller": "Toyota Dealership",
            "active": true,
            "type": [
                {
                    "type_name": "Camionnette",
                    "active": true,
                    "no": "2"
                }
            ]
        },
        {
            "no": "1",
            "aff_number": "EQ-001",
            "num_equip": "MEUB-2022-001",
            "year": "2022",
            "brand": "Ikea",
            "nummodel": "Billy",
            "numserial": "SNBILLY001",
            "purchase_date": "2022-11-01",
            "purchase_seller": "Ikea Store",
            "active": true,
            "type": [
                {
                    "type_name": "Meuble",
                    "active": true,
                    "no": "3"
                }
            ]
        }
    ]
}
Réponses d'erreur spécifiques

401 Unauthorized Aucune clé API valide fournie

403 Forbidden La clé API n'a pas les permissions necessaires pour exécuter la requête

500 Internal Server Error Une erreur interne du serveur s'est produite

Trouver un équipement

Retourne les informations de l'équipement dont le numéro {no} est fourni. Si aucun équipement n'est trouvé, le code 400 et un tableau vide sont retournés.

Attributs

no int
Numéro de l'équipement unique dans votre silo. Identifiant de l'équipement.

aff_number stringUnique dans le silo. Généré par Planiso.
Numéro d'équipement généré automatiquement à la création par Planiso avec le préfix "EQ-". Il est unique par équipement dans votre silo. Il est utilisé pour identifier l'équipement dans l'application.

num_equip stringRequis pour créer un équipement dans Planiso
Numéro ou nom personnalisé de l'équipement

year int|nullDoit être supérieur à 1900 et inférieur ou égale à l'année actuelle
Année de fabrication de l'équipement

brand nameRequis dans pour création un équipement dans Planiso
Marque de l'équipement

nummodel string|null
Numéro de modèle de l'équipement

numserial string|null
Numéro de série de l'équipement.

purchase_date string|nullLe format de la date des achats acceptée par l'API est Y-m-d
Date d'achat de l'équipement

purchase_seller string|null
Représente le vendeur de l'équipement à qui l'équipement a été acheté.

active boolean
Indique si l'équipement est actif ou non.

type array
Tableau des types d'équipements liés à l'équipement contenant les attributs suivants : no, type_name, active.

Retours

object Un tableau associatif avec une propriété de données qui contient un tableau d'attributs sur l'équipement qui correspondant au numéro {no} fourni.

Point de terminaison
GET/v1/equipment/{no}
Demande
curl https://api.planiso.com/v1/equipment/{no} \
    -X GET \
    -H "Authorization: Bearer {API_KEY}" \
Réponse
{
    "code": 200,
    "message": "Equipment found",
    "data": {
        "no": "2",
        "aff_number": "EQ-002",
        "num_equip": "CAM-2023-001",
        "year": "2023",
        "brand": "Toyota",
        "nummodel": "Hiace",
        "numserial": "SNTOYOTA12345",
        "purchase_date": "2023-06-15",
        "purchase_seller": "Toyota Dealership",
        "active": true,
        "type": [
            {
                "type_name": "Camionnette",
                "active": true,
                "no": "2"
            }
        ]
    }
}

Création d'un équipement

Dans L'API Planiso, vous pouvez ajouter un nouvel équipement avec quelques informations. Vous êtes en mesure d'associer un ou des type d'équipements à votre ajout. Pour obtenir la liste des types d'équipements disponibles dans votre silo, voir la section Liste des types d'équipement. Pour lier des types d'équipements au nouvel équipement, remplir le champs "type_nos" avec les numéro des types d'équipements separés par des virgules. Le format de la date des achats acceptée par l'API est Y-m-d.

Attributs

no int
Numéro de l'équipement unique dans votre silo. Identifiant de l'équipement.

aff_number stringUnique dans le silo. Généré par Planiso.
Numéro d'équipement généré automatiquement à la création par Planiso avec le préfix "EQ-". Il est unique par équipement dans votre silo. Il est utilisé pour identifier l'équipement dans l'application.

num_equip stringRequis pour créer un équipement dans Planiso
Numéro ou nom personnalisé de l'équipement

year int|nullDoit être supérieur à 1900 et inférieur ou égale à l'année actuelle
Année de fabrication de l'équipement

brand nameRequis dans pour création un équipement dans Planiso
Marque de l'équipement

nummodel string|null
Numéro de modèle de l'équipement

numserial string|null
Numéro de série de l'équipement.

purchase_date string|nullLe format de la date des achats acceptée par l'API est Y-m-d
Date d'achat de l'équipement

purchase_seller string|null
Représente le vendeur de l'équipement à qui l'équipement a été acheté.

active boolean
Indique si l'équipement est actif ou non.

type array
Tableau des types d'équipements liés à l'équipement contenant les attributs suivants : no, type_name, active.

Retours

object Un array associatif contenant une propriété de données qui contient un tableau d'attributs sur l'équipement qui correspondant à l'équipement créé.

Point de terminaison
POST/v1/equipment
Demande
curl https://api.planiso.com/v1/equipment \
    -X POST \
    -H "Authorization: Bearer {API_KEY}" \
    -d "num_equip=FRIGO-2024-001" \
    -d "year=2024" \
    -d "brand=Whirlpool" \
    -d "nummodel=WRT311FZDW" \
    -d "numserial=SNWHIRLPOOL4567" \
    -d "purchase_date=2024-03-10" \
    -d "purchase_seller=Appliance Store" \
    -d "type_nos=1,3"
Réponse
{
    "code": 201,
    "message": "equipment inserted successfully",
    "data": {
        "no": 32,
        "aff_number": "EQ-032",
        "num_equip": "FRIGO-2024-001",
        "year": "2024",
        "brand": "Whirlpool",
        "nummodel": "WRT311FZDW",
        "numserial": "SNWHIRLPOOL4567",
        "purchase_date": "2024-03-10",
        "purchase_seller": "Appliance Store",
        "active": true,
        "type": [
            {
                "type_name": "Frigo",
                "active": true,
                "no": "3"
            }
        ]
    }
}

Modifier un équipement

Cette méthode permet de modifier un équipement existant dans Planiso. Il n'est pas possible de modifier les types d'équipements liés à un équipement à partir de cette méthode.

Attributs

no int
Numéro de l'équipement unique dans votre silo. Identifiant de l'équipement.

aff_number stringUnique dans le silo. Généré par Planiso.
Numéro d'équipement généré automatiquement à la création par Planiso avec le préfix "EQ-". Il est unique par équipement dans votre silo. Il est utilisé pour identifier l'équipement dans l'application.

num_equip stringRequis pour créer un équipement dans Planiso
Numéro ou nom personnalisé de l'équipement

year int|nullDoit être supérieur à 1900 et inférieur ou égale à l'année actuelle
Année de fabrication de l'équipement

brand nameRequis dans pour création un équipement dans Planiso
Marque de l'équipement

nummodel string|null
Numéro de modèle de l'équipement

numserial string|null
Numéro de série de l'équipement.

purchase_date string|nullLe format de la date des achats acceptée par l'API est Y-m-d
Date d'achat de l'équipement

purchase_seller string|null
Représente le vendeur de l'équipement à qui l'équipement a été acheté.

active boolean
Indique si l'équipement est actif ou non.

type array
Tableau des types d'équipements liés à l'équipement contenant les attributs suivants : no, type_name, active.

Retours

object Un array associatif contenant une propriété de données qui contient un tableau des attributs qui ont été modifiés sur l'équipement dont le numéro {no} est fourni.

Point de terminaison
PUT/v1/equipment/{no}
Demande
curl https://api.planiso.com/v1/equipment/{no} \
    -X PUT \
    -H "Authorization: Bearer {API_KEY}" \
    -d "num_equip=FRIGO-2024-002" \
    -d "year=2024" \
    -d "brand=Whirlpool" \
    -d "nummodel=WRT312BZDW" \
    -d "numserial=SNWHIRLPOOL7890" \
    -d "purchase_date=2024-05-15" \
    -d "purchase_seller=Premium Appliance Store"
Réponse
{
    "code": 200,
    "message": "Equipment updated successfully",
    "data": {
        "num_equip": "FRIGO-2024-002",
        "year": "2024",
        "brand": "Whirlpool",
        "nummodel": "WRT312BZDW",
        "numserial": "SNWHIRLPOOL7890",
        "purchase_date": "2024-05-15",
        "purchase_seller": "Premium Appliance Store",
        "last_update": "2024-11-25 19:14:10",
        "no": 32
    }
}
Réponses d'erreur spécifiques

400 Bad Request Un ou plusieurs champs requis sont manquants ou ont un mauvais format, ou des champs fournis sont invalides. {year} n'a pas le bon format, par exemple.

401 Unauthorized Aucune clé API valide fournie

403 Forbidden Aucune clé API valide fournie

404 Not Found L'équipement {no} n'existe pas

409 Conflict La requête entre en conflit avec une autre requête, probablement en raison d'un conflit de clé unique désistantante, comme le numéro d'équipement {num_equip}.

500 Internal Server Error Une erreur interne du serveur est survenue.

Supprimer un équipement

Cette méthode permet de désactiver un équipement existant dans Planiso. Il n'est pas possible de modifier les types d'équipements liés à un équipement à partir de cette méthode.

Attributs

no int
Numéro de l'équipement unique dans votre silo. Identifiant de l'équipement.

aff_number stringUnique dans le silo. Généré par Planiso.
Numéro d'équipement généré automatiquement à la création par Planiso avec le préfix "EQ-". Il est unique par équipement dans votre silo. Il est utilisé pour identifier l'équipement dans l'application.

num_equip stringRequis pour créer un équipement dans Planiso
Numéro ou nom personnalisé de l'équipement

year int|nullDoit être supérieur à 1900 et inférieur ou égale à l'année actuelle
Année de fabrication de l'équipement

brand nameRequis dans pour création un équipement dans Planiso
Marque de l'équipement

nummodel string|null
Numéro de modèle de l'équipement

numserial string|null
Numéro de série de l'équipement.

purchase_date string|nullLe format de la date des achats acceptée par l'API est Y-m-d
Date d'achat de l'équipement

purchase_seller string|null
Représente le vendeur de l'équipement à qui l'équipement a été acheté.

active boolean
Indique si l'équipement est actif ou non.

type array
Tableau des types d'équipements liés à l'équipement contenant les attributs suivants : no, type_name, active.

Retours

object Un array vide.

Point de terminaison
DELETE/v1/equipment/{no}
Demande
curl https://api.planiso.com/v1/equipment/{no} \
    -X DELETE \
    -H "Authorization: Bearer {API_KEY}" \
Réponse
{
    "code": 200,
    "message": "Equipment deleted successfully",
    "data": []
}
Réponses d'erreur spécifiques

401 Unauthorized Aucune clé API valide fournie

403 Forbidden Aucune clé API valide fournie

404 Not Found L'équipement {no} n'existe pas

500 Internal Server Error Une erreur interne du serveur est survenue.

Types d'équipement

Cet objet permet d'obtenir la liste des types d'équipements disponibles dans votre silo Planiso. Pour modifier, ajouter ou supprimer un type d'équipement, il est nécessaire de se rendre directement dans votre silo Planiso . Les types d'équipements sont nécessaire lors de la création d'un nouvel équipement.

Points de terminaison

GET/v1/equipment_type

Liste des types d'équipement

Retourne la liste de tous les types d'équipements contenu dans votre silo Planiso. Les types d'équipements sont retournés triés par ordre alphabétique. Si aucun type d'équipement n'est trouvé, une liste vide est retournée.

Attributs

no int
Numéro du type d'équipement unque dans votre silo. Identifiant du type d'équipement.

type_name string
Le nom du type d'équipement. Exemple : Camionnette, Meuble, etc.

active boolean
Indique si le type d'équipement est actif ou non.

Retours

object Un tableau associatif avec une propriété de données qui contient un tableau dde type d'équipements triés par ordre alphabétique.

Point de terminaison
GET/v1/equipment_type
Demande
curl https://api.planiso.com/v1/equipment_type \
    -X GET \
    -H "Authorization: Bearer {API_KEY}" \
Réponse
{
    "code": 200,
    "message": "",
    "data": [
        {
            "no": "2",
            "type_name": "Camionnette",
            "active": "1"
        },
        {
            "no": "3",
            "type_name": "Meuble",
            "active": "1"
        }
    ]
}
Réponses d'erreur spécifiques

401 Unauthorized Aucune clé API valide fournie

403 Forbidden La clé API n'a pas les permissions necessaires pour exécuter la requête

500 Internal Server Error Une erreur interne du serveur s'est produite