{
  "swagger": "2.0",
  "info": {
    "title": "Adjulo",
    "description": "Appels d'offres publics du Québec (SEAO) et du gouvernement du Canada (CanadaBuys) : lisez vos opportunités InsightsVibe et la fiche de chaque avis, et faites vivre votre pipeline InsightsPipeline : suivre, faire avancer, retirer.",
    "version": "1.0",
    "contact": {
      "name": "Adjulo",
      "url": "https://adjulo.ca",
      "email": "info@adjulo.ca"
    }
  },
  "host": "api.adjulo.io",
  "basePath": "/",
  "schemes": [
    "https"
  ],
  "consumes": [
    "application/json"
  ],
  "produces": [
    "application/json"
  ],
  "securityDefinitions": {
    "api_key": {
      "type": "apiKey",
      "in": "header",
      "name": "X-API-Key"
    }
  },
  "security": [
    {
      "api_key": []
    }
  ],
  "tags": [
    {
      "name": "Appels d'offres"
    },
    {
      "name": "InsightsVibe"
    },
    {
      "name": "InsightsPipeline"
    },
    {
      "name": "Compte"
    }
  ],
  "paths": {
    "/v1/appels-offres/{ao_id}": {
      "get": {
        "tags": [
          "Appels d'offres"
        ],
        "operationId": "ObtenirAppelOffres",
        "summary": "Obtenir un appel d'offres",
        "description": "Fiche d'un avis, à partir de son identifiant public (champ « Identifiant public » de « Lister mes opportunités »).",
        "parameters": [
          {
            "name": "ao_id",
            "in": "path",
            "required": true,
            "type": "string",
            "x-ms-summary": "Identifiant public de l'avis",
            "x-ms-url-encoding": "single"
          }
        ],
        "responses": {
          "200": {
            "description": "Fiche de l'avis",
            "schema": {
              "$ref": "#/definitions/AppelOffresDetail"
            }
          }
        }
      }
    },
    "/v1/vibe/opportunites": {
      "get": {
        "tags": [
          "InsightsVibe"
        ],
        "operationId": "ListerMesOpportunites",
        "summary": "Lister mes opportunités",
        "description": "Avis ouverts classés par pertinence pour votre entreprise (InsightsVibe : votre marché et votre historique de soumissions). Le classement dit la pertinence d'un avis, pas une chance de gagner.",
        "parameters": [
          {
            "name": "limit",
            "in": "query",
            "type": "integer",
            "minimum": 1,
            "x-ms-summary": "Nombre d'opportunités",
            "description": "Par défaut, tout ce que votre plan permet."
          },
          {
            "name": "rayon_km",
            "in": "query",
            "type": "integer",
            "x-ms-summary": "Rayon (km)",
            "description": "Ne garder que les avis dont l'acheteur est à moins de ce nombre de kilomètres d'une de vos entreprises.",
            "x-ms-visibility": "advanced"
          }
        ],
        "responses": {
          "200": {
            "description": "Opportunités",
            "schema": {
              "$ref": "#/definitions/ListeOpportunites"
            }
          }
        }
      }
    },
    "/v1/me": {
      "get": {
        "tags": [
          "Compte"
        ],
        "operationId": "ObtenirMonProfil",
        "summary": "Obtenir mon profil",
        "description": "Profil du compte Adjulo de la connexion (utile pour vérifier la connexion).",
        "parameters": [],
        "responses": {
          "200": {
            "description": "Profil",
            "schema": {
              "type": "object",
              "properties": {
                "numero_client": {
                  "type": "string",
                  "x-ms-summary": "Numéro de client"
                },
                "email": {
                  "type": "string",
                  "x-ms-summary": "Courriel"
                },
                "prenom": {
                  "type": "string",
                  "x-ms-summary": "Prénom"
                },
                "nom": {
                  "type": "string",
                  "x-ms-summary": "Nom"
                },
                "entreprise": {
                  "type": "string",
                  "x-ms-summary": "Entreprise"
                },
                "plan": {
                  "type": "string",
                  "x-ms-summary": "Plan"
                }
              }
            }
          }
        }
      }
    },
    "/v1/pipeline": {
      "get": {
        "tags": [
          "InsightsPipeline"
        ],
        "operationId": "ListerMonPipeline",
        "summary": "Lister mon pipeline",
        "description": "Avis suivis dans votre pipeline Adjulo, avec leur étape et leur état ; les avis actifs d'abord, par échéance.",
        "parameters": [
          {
            "name": "etape",
            "in": "query",
            "required": false,
            "x-ms-summary": "Étape",
            "type": "string",
            "description": "Ne garder que les avis à cette étape.",
            "enum": [
              "repere",
              "evaluation",
              "go",
              "no_go",
              "documents",
              "preparation",
              "soumis",
              "non_soumis"
            ],
            "x-ms-enum-values": [
              {
                "value": "repere",
                "displayName": "Repéré"
              },
              {
                "value": "evaluation",
                "displayName": "À évaluer"
              },
              {
                "value": "go",
                "displayName": "Go"
              },
              {
                "value": "no_go",
                "displayName": "No-go"
              },
              {
                "value": "documents",
                "displayName": "Documents"
              },
              {
                "value": "preparation",
                "displayName": "En préparation"
              },
              {
                "value": "soumis",
                "displayName": "Soumis"
              },
              {
                "value": "non_soumis",
                "displayName": "Non soumis"
              }
            ]
          },
          {
            "name": "etat",
            "in": "query",
            "required": false,
            "x-ms-summary": "État",
            "description": "Actif (en cours) ou clos.",
            "type": "string",
            "enum": [
              "actif",
              "clos"
            ],
            "x-ms-enum-values": [
              {
                "value": "actif",
                "displayName": "Actif"
              },
              {
                "value": "clos",
                "displayName": "Clos"
              }
            ]
          },
          {
            "name": "assigne_a",
            "in": "query",
            "required": false,
            "type": "integer",
            "x-ms-summary": "Membre assigné",
            "description": "Identifiant du membre de votre équipe qui pilote l'avis.",
            "x-ms-visibility": "advanced"
          }
        ],
        "responses": {
          "200": {
            "description": "Avis suivis",
            "schema": {
              "$ref": "#/definitions/ListePipeline"
            }
          }
        }
      },
      "post": {
        "tags": [
          "InsightsPipeline"
        ],
        "operationId": "SuivreDansPipeline",
        "summary": "Suivre un appel d'offres dans mon pipeline",
        "description": "Ajoute un avis ouvert au pipeline (étape « Repéré »). Sans effet si l'avis y est déjà. Les CRM reliés le reçoivent.",
        "parameters": [
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "type": "object",
              "required": [
                "ao_id"
              ],
              "properties": {
                "ao_id": {
                  "type": "integer",
                  "x-ms-summary": "Identifiant interne de l'avis",
                  "description": "Le champ « Identifiant interne » d'une opportunité ou d'une fiche — pas l'identifiant public."
                }
              }
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Avis suivi",
            "schema": {
              "type": "object",
              "properties": {
                "ok": {
                  "type": "boolean",
                  "x-ms-summary": "Réussi"
                },
                "ao_id": {
                  "type": "integer",
                  "x-ms-summary": "Identifiant interne"
                },
                "nouveau": {
                  "type": "boolean",
                  "x-ms-summary": "Ajouté par cet appel",
                  "description": "Faux si l'avis était déjà suivi."
                }
              }
            }
          }
        }
      }
    },
    "/v1/pipeline/{ao_id}": {
      "patch": {
        "tags": [
          "InsightsPipeline"
        ],
        "operationId": "FaireAvancerDansPipeline",
        "summary": "Faire avancer un appel d'offres dans mon pipeline",
        "description": "Change l'étape, l'état, le membre assigné ou le contrat signé d'un avis suivi. Une étape « No-go » ou « Non soumis » clôt l'avis. Les CRM reliés reçoivent le changement.",
        "parameters": [
          {
            "name": "ao_id",
            "in": "path",
            "required": true,
            "type": "integer",
            "x-ms-summary": "Identifiant interne de l'avis",
            "description": "Le champ « Identifiant interne » d'une opportunité, d'une fiche ou d'un avis du pipeline — pas l'identifiant public."
          },
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "type": "object",
              "properties": {
                "etape": {
                  "type": "string",
                  "x-ms-summary": "Nouvelle étape",
                  "description": "Étape du pipeline où placer l'avis.",
                  "enum": [
                    "repere",
                    "evaluation",
                    "go",
                    "no_go",
                    "documents",
                    "preparation",
                    "soumis",
                    "non_soumis"
                  ],
                  "x-ms-enum-values": [
                    {
                      "value": "repere",
                      "displayName": "Repéré"
                    },
                    {
                      "value": "evaluation",
                      "displayName": "À évaluer"
                    },
                    {
                      "value": "go",
                      "displayName": "Go"
                    },
                    {
                      "value": "no_go",
                      "displayName": "No-go"
                    },
                    {
                      "value": "documents",
                      "displayName": "Documents"
                    },
                    {
                      "value": "preparation",
                      "displayName": "En préparation"
                    },
                    {
                      "value": "soumis",
                      "displayName": "Soumis"
                    },
                    {
                      "value": "non_soumis",
                      "displayName": "Non soumis"
                    }
                  ]
                },
                "etat": {
                  "x-ms-summary": "État",
                  "description": "Actif ou clos.",
                  "type": "string",
                  "enum": [
                    "actif",
                    "clos"
                  ],
                  "x-ms-enum-values": [
                    {
                      "value": "actif",
                      "displayName": "Actif"
                    },
                    {
                      "value": "clos",
                      "displayName": "Clos"
                    }
                  ]
                },
                "assigne_a": {
                  "type": "integer",
                  "x-ms-summary": "Membre assigné",
                  "description": "Identifiant du membre qui pilote l'avis ; 0 pour retirer l'assignation.",
                  "x-ms-visibility": "advanced"
                },
                "contrat_signe": {
                  "type": "boolean",
                  "x-ms-summary": "Contrat signé",
                  "x-ms-visibility": "advanced"
                }
              }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Avis modifié",
            "schema": {
              "type": "object",
              "properties": {
                "ok": {
                  "type": "boolean",
                  "x-ms-summary": "Réussi"
                },
                "ao_id": {
                  "type": "integer",
                  "x-ms-summary": "Identifiant interne"
                },
                "inchange": {
                  "type": "boolean",
                  "x-ms-summary": "Rien à changer",
                  "description": "Vrai si l'avis était déjà dans cet état."
                }
              }
            }
          }
        }
      },
      "delete": {
        "tags": [
          "InsightsPipeline"
        ],
        "operationId": "RetirerDuPipeline",
        "summary": "Retirer un appel d'offres de mon pipeline",
        "description": "Retire un avis suivi de votre pipeline, avec son fil de suivi. Irréversible : à réserver aux flux que vous déclenchez vous-même.",
        "parameters": [
          {
            "name": "ao_id",
            "in": "path",
            "required": true,
            "type": "integer",
            "x-ms-summary": "Identifiant interne de l'avis",
            "description": "Le champ « Identifiant interne » d'une opportunité, d'une fiche ou d'un avis du pipeline — pas l'identifiant public."
          }
        ],
        "responses": {
          "204": {
            "description": "Avis retiré"
          }
        }
      }
    }
  },
  "definitions": {
    "Organisme": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "x-ms-summary": "Identifiant de l'organisme"
        },
        "nom": {
          "type": "string",
          "x-ms-summary": "Organisme"
        }
      }
    },
    "AppelOffresDetail": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "x-ms-summary": "Identifiant public"
        },
        "ao_id": {
          "type": "integer",
          "x-ms-summary": "Identifiant interne",
          "description": "À donner aux actions du pipeline."
        },
        "titre": {
          "type": "string",
          "x-ms-summary": "Titre"
        },
        "statut": {
          "type": "string",
          "x-ms-summary": "Statut"
        },
        "source": {
          "type": "string",
          "x-ms-summary": "Source"
        },
        "categorie": {
          "type": "string",
          "x-ms-summary": "Nature"
        },
        "methode_approvisionnement": {
          "type": "string",
          "x-ms-summary": "Mode d'adjudication"
        },
        "valeur_estimee": {
          "type": "number",
          "x-ms-summary": "Valeur estimée"
        },
        "url_seao": {
          "type": "string",
          "x-ms-summary": "Lien de l'avis"
        },
        "date_publication": {
          "type": "string",
          "format": "date-time",
          "x-ms-summary": "Publié le"
        },
        "date_echeance": {
          "type": "string",
          "format": "date-time",
          "x-ms-summary": "Échéance"
        },
        "organisme": {
          "$ref": "#/definitions/Organisme"
        },
        "nb_soumissionnaires": {
          "type": "integer",
          "x-ms-summary": "Nombre de soumissionnaires"
        },
        "nb_contrats": {
          "type": "integer",
          "x-ms-summary": "Nombre de contrats"
        }
      }
    },
    "ListeOpportunites": {
      "type": "object",
      "properties": {
        "data": {
          "type": "array",
          "x-ms-summary": "Opportunités",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "integer",
                "x-ms-summary": "Identifiant interne",
                "description": "À donner aux actions du pipeline. Pour « Obtenir un appel d'offres », utiliser l'identifiant public."
              },
              "seao_id": {
                "type": "string",
                "x-ms-summary": "Identifiant public"
              },
              "titre": {
                "type": "string",
                "x-ms-summary": "Titre"
              },
              "palier": {
                "type": "string",
                "x-ms-summary": "Niveau de pertinence"
              },
              "organisme_nom": {
                "type": "string",
                "x-ms-summary": "Organisme"
              },
              "valeur_estimee": {
                "type": "number",
                "x-ms-summary": "Valeur estimée"
              },
              "date_echeance": {
                "type": "string",
                "format": "date-time",
                "x-ms-summary": "Échéance"
              },
              "source": {
                "type": "string",
                "x-ms-summary": "Source"
              },
              "source_url": {
                "type": "string",
                "x-ms-summary": "Lien de l'avis"
              },
              "distance_km": {
                "type": "integer",
                "x-ms-summary": "Distance (km)"
              }
            }
          }
        },
        "apercu": {
          "type": "boolean",
          "x-ms-summary": "Aperçu sectoriel",
          "description": "Vrai quand la liste est un aperçu de votre secteur plutôt qu'un classement de vos opportunités."
        },
        "total_vivier": {
          "type": "integer",
          "x-ms-summary": "Opportunités au total"
        }
      }
    },
    "ListePipeline": {
      "type": "object",
      "properties": {
        "data": {
          "type": "array",
          "x-ms-summary": "Avis suivis",
          "items": {
            "type": "object",
            "properties": {
              "ao_id": {
                "type": "integer",
                "x-ms-summary": "Identifiant interne",
                "description": "À donner aux autres actions du pipeline."
              },
              "titre": {
                "type": "string",
                "x-ms-summary": "Titre"
              },
              "etape": {
                "type": "string",
                "x-ms-summary": "Étape"
              },
              "etat": {
                "type": "string",
                "x-ms-summary": "État"
              },
              "organisme_nom": {
                "type": "string",
                "x-ms-summary": "Organisme"
              },
              "date_echeance": {
                "type": "string",
                "x-ms-summary": "Échéance",
                "format": "date-time"
              },
              "valeur_estimee": {
                "type": "number",
                "x-ms-summary": "Valeur estimée"
              },
              "statut": {
                "type": "string",
                "x-ms-summary": "Statut de l'avis"
              },
              "source": {
                "type": "string",
                "x-ms-summary": "Source"
              },
              "source_url": {
                "type": "string",
                "x-ms-summary": "Lien de l'avis"
              },
              "assigne_prenom": {
                "type": "string",
                "x-ms-summary": "Prénom du membre assigné"
              },
              "assigne_nom": {
                "type": "string",
                "x-ms-summary": "Nom du membre assigné"
              },
              "contrat_signe": {
                "type": "boolean",
                "x-ms-summary": "Contrat signé"
              },
              "adjuge": {
                "type": "boolean",
                "x-ms-summary": "Adjugé"
              },
              "date_adjudication": {
                "type": "string",
                "x-ms-summary": "Date d'adjudication"
              },
              "nb_notes": {
                "type": "integer",
                "x-ms-summary": "Nombre de notes"
              },
              "created_at": {
                "type": "string",
                "x-ms-summary": "Suivi depuis le",
                "format": "date-time"
              }
            }
          }
        }
      }
    }
  },
  "x-ms-connector-metadata": [
    {
      "propertyName": "Website",
      "propertyValue": "https://adjulo.ca"
    },
    {
      "propertyName": "Privacy policy",
      "propertyValue": "https://adjulo.ca/confidentialite"
    },
    {
      "propertyName": "Categories",
      "propertyValue": "Data;Business Intelligence"
    }
  ]
}
