Skip to content

Routines / Scoring

Permet de consulter et gérer les données de scoring et de taggage des sociétés sur les routines.

Récupérer les données de scoring

GET /v1/supply/identification

Retourne les données de scoring et d'identification des sociétés sur une routine.

Headers

NomTypeRequisDescription
x-access-tokenStringouiClé API

Paramètres query

NomTypeRequisDescription
idSupplyintnonIdentifiant de la routine
idCompanyint|int[]nonIdentifiant(s) de société
sirenStringnonNuméro SIREN
minScoringMatchintnonScore minimum
pollingScoringintnonScorings modifiés dans les X dernières minutes (min. 15)
pollingTagintnonTags de routine modifiés dans les X dernières minutes (min. 15)

Réponses

200 — OK
json
{
    "success": true,
    "code": "200",
    "message": "OK",
    "parameters": {},
    "result": {
        "identificationList": ["<SupplyIdentification>"]
    }
}
400 — Bad Request
json
{
    "success": false,
    "code": "400",
    "message": "Paramètre incorrect"
}

Créer ou modifier un tag de société sur une routine

POST /v1/supply/identification

Crée ou modifie le tag d'une société sur une routine. Les paramètres vides ne sont pas écrasés lors d'une modification.

Headers

NomTypeRequisDescription
x-access-tokenStringouiClé API

Body (JSON)

NomTypeRequisDescription
idSupplyintouiIdentifiant de la routine
idCompanyintconditionnelIdentifiant de la société. Obligatoire si siren n'est pas renseigné
sirenStringconditionnelNuméro SIREN. Obligatoire si idCompany n'est pas renseigné
idIdentificationTypeint|nullnonType d'identification
isFormerCustomerboolean|nullnonAncien client

Réponses

200 — OK
json
{
    "success": true,
    "code": "200",
    "message": "OK",
    "parameters": {},
    "result": {}
}
400 — Bad Request
json
{
    "success": false,
    "code": "400",
    "message": "Le paramètre idSupply est requis"
}
404 — Not Found
json
{
    "success": false,
    "code": "404",
    "message": "Routine introuvable"
}

Récupérer les types d'identification

GET /v1/supply/identificationType

Retourne la liste des types d'identification disponibles.

Headers

NomTypeRequisDescription
x-access-tokenStringouiClé API

Réponses

200 — OK
json
{
    "success": true,
    "code": "200",
    "message": "OK",
    "parameters": {},
    "result": {
        "identificationTypeList": [
            {
                "idIdentificationType": "int",
                "title": "string"
            }
        ]
    }
}

Coefficy — API externe