Importez les clés d'identité des demandes CEE existantes par lot

POST /policies/cee/import/identity

L'API peut être utilisée jusqu'à 20.000x par minute.

application/json

Body object Required

Précédente demande de CEE.

S'il s'agit d'une opération spécifique, le payload est le même que sur l'import, en ajoutant le champs "cee_application_type": "specific".

S'il s'agit d'une opération standarisée, il convient d'envoyer l'UUID de la demande tel que :

{
  "cee_application_type": "standardized",
  "cee_application_uuid": "{{uuid de la demande}}",
  "identity_key": "{{identity_key}}"
}

cee_application_type string Required

Type de demande CEE

Values are specific or standardized.
cee_application_uuid string(uuid) Required

UUID de la demande
identity_key string Required
Correspond au SHA d'une chaîne concaténée tel que : sha256({phone_number}-{last_name}) où :
- phone_number correspond au numéro de téléphone complet au format international sans espace ni tiret. Exemple : +33601020304
- last_name correspond au nom de famille complet en majuscule, sans accent ni tiret ni apostrophe : Regexp: [A-Z ]*
Exemple, M. D'Hérûg-de-l'Hérault ayant le numéro 07 01 02 03 04 doit être formatté comme suit +33701020304-D HERUG DE L HERAULT
Minimum length is 64, maximum length is 64.
journey_type string

Values are short or long.
phone_trunc string

Numéro de téléphone au format ITU-T E.164 tronqué des 2 derniers chiffres

Minimum length is 10, maximum length is 14. Format should match the following pattern: ^\+[0-9]{8,12}$.
last_name_trunc string

Correspond aux trois premièrs caractères du nom de famille complet en majuscule, sans accent ni tiret ni apostrophe. Dans le cas où le nom comporterait moins de 3 lettres, compléter avec des espaces. Ex 1: M. D'Hérûg-de-l'Hérault => "D H" Ex 2: M. Tô => "TO "

Minimum length is 3, maximum length is 3. Format should match the following pattern: ^[A-Z ]{3}$.
datetime string(datetime)

Date d'engagement de l'opération concernée.

Précédente demande de CEE.

S'il s'agit d'une opération spécifique, le payload est le même que sur l'import, en ajoutant le champs "cee_application_type": "specific".

S'il s'agit d'une opération standarisée, il convient d'envoyer l'UUID de la demande tel que :

{
  "cee_application_type": "standardized",
  "cee_application_uuid": "{{uuid de la demande}}",
  "identity_key": "{{identity_key}}"
}

cee_application_type string Required

Type de demande CEE

Values are specific or standardized.
cee_application_uuid string(uuid)

UUID de la demande
identity_key string Required
Correspond au SHA d'une chaîne concaténée tel que : sha256({phone_number}-{last_name}) où :
- phone_number correspond au numéro de téléphone complet au format international sans espace ni tiret. Exemple : +33601020304
- last_name correspond au nom de famille complet en majuscule, sans accent ni tiret ni apostrophe : Regexp: [A-Z ]*
Exemple, M. D'Hérûg-de-l'Hérault ayant le numéro 07 01 02 03 04 doit être formatté comme suit +33701020304-D HERUG DE L HERAULT
Minimum length is 64, maximum length is 64.
journey_type string Required

Values are short or long.
phone_trunc string Required

Numéro de téléphone au format ITU-T E.164 tronqué des 2 derniers chiffres

Minimum length is 10, maximum length is 14. Format should match the following pattern: ^\+[0-9]{8,12}$.
last_name_trunc string Required

Correspond aux trois premièrs caractères du nom de famille complet en majuscule, sans accent ni tiret ni apostrophe. Dans le cas où le nom comporterait moins de 3 lettres, compléter avec des espaces. Ex 1: M. D'Hérûg-de-l'Hérault => "D H" Ex 2: M. Tô => "TO "

Minimum length is 3, maximum length is 3. Format should match the following pattern: ^[A-Z ]{3}$.
datetime string(datetime) Required

Date d'engagement de l'opération concernée.

Responses

200 application/json

OK
Hide response attributes Show response attributes object
- imported number Required
  
  Nombre de demandes importées avec succès
  
  Minimum value is 0, maximum value is 1000.
- failed number Required
  
  Nombre de demandes non importées
  
  Minimum value is 0, maximum value is 1000.
- failed_details array[object] Required
  
  At least 0 but not more than 1000 elements.
  
  Hide failed_details attributes Show failed_details attributes object
  
  cee_application_type string Required
  
  Type de demande CEE
  
  Values are specific or standardized.
  
  cee_application_uuid string(uuid) Required
  
  UUID de la demande
  
  identity_key string Required
  
  Correspond au SHA d'une chaîne concaténée tel que : sha256({phone_number}-{last_name}) où :
  
  phone_number correspond au numéro de téléphone complet au format international sans espace ni tiret. Exemple : +33601020304
  
  last_name correspond au nom de famille complet en majuscule, sans accent ni tiret ni apostrophe : Regexp: [A-Z ]*
  
  Exemple, M. D'Hérûg-de-l'Hérault ayant le numéro 07 01 02 03 04 doit être formatté comme suit +33701020304-D HERUG DE L HERAULT
  
  Minimum length is 64, maximum length is 64.
  
  journey_type string Required
  
  Values are short or long.
  
  phone_trunc string Required
  
  Numéro de téléphone au format ITU-T E.164 tronqué des 2 derniers chiffres
  
  Minimum length is 10, maximum length is 14. Format should match the following pattern: ^\+[0-9]{8,12}$.
  
  last_name_trunc string Required
  
  Correspond aux trois premièrs caractères du nom de famille complet en majuscule, sans accent ni tiret ni apostrophe. Dans le cas où le nom comporterait moins de 3 lettres, compléter avec des espaces. Ex 1: M. D'Hérûg-de-l'Hérault => "D H" Ex 2: M. Tô => "TO "
  
  Minimum length is 3, maximum length is 3. Format should match the following pattern: ^[A-Z ]{3}$.
  
  datetime string(datetime) Required
  
  Date d'engagement de l'opération concernée.
  
  error string Required
400 application/json

Requête invalide
401 application/json

Non authentifié. Le token applicatif est manquant ou invalide.
403 application/json

Non autorisé

POST /policies/cee/import/identity

curl \
 --request POST 'https://api.demo.covoiturage.beta.gouv.fr/v3.3/policies/cee/import/identity' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '[{"cee_application_type":"specific","cee_application_uuid":"string","identity_key":"string","journey_type":"short","phone_trunc":"+336010203","last_name_trunc":"string","datetime":"string"}]'

Request examples

[
  {
    "cee_application_type": "specific",
    "cee_application_uuid": "string",
    "identity_key": "string",
    "journey_type": "short",
    "phone_trunc": "+336010203",
    "last_name_trunc": "string",
    "datetime": "string"
  }
]

Response examples (200)

{
  "imported": 42.0,
  "failed": 42.0,
  "failed_details": [
    {
      "cee_application_type": "specific",
      "cee_application_uuid": "string",
      "identity_key": "string",
      "journey_type": "short",
      "phone_trunc": "+336010203",
      "last_name_trunc": "string",
      "datetime": "string",
      "error": "string"
    }
  ]
}

Response examples (400)

{
  "id": 1,
  "error": {
    "code": -32602,
    "data": "data/driver/identity/phone_trunc must match format \"phonetrunc\", data/driver/identity/phone_trunc must pass \"macro\" keyword validation",
    "message": "Invalid params"
  },
  "jsonrpc": "2.0"
}

Response examples (401)

{
  "id": 1,
  "error": {
    "code": -32501,
    "data": "Unauthorized application",
    "message": "Unauthorized Error"
  },
  "jsonrpc": "2.0"
}

Response examples (403)

{
  "id": 1,
  "error": {
    "code": -32503,
    "data": "Invalid permissions",
    "message": "Forbidden Error"
  },
  "jsonrpc": "2.0"
}