Différences
Ci-dessous, les différences entre deux révisions de la page.
| Les deux révisions précédentesRévision précédenteProchaine révision | Révision précédente | ||
| documentation_technique_scripts [2025/05/20 16:29] – ctisserand | documentation_technique_scripts [2025/05/20 16:38] (Version actuelle) – ctisserand | ||
|---|---|---|---|
| Ligne 1: | Ligne 1: | ||
| + | ====== Documentation pour écrire un script custom (LUA) ====== | ||
| + | |||
| + | < | ||
| # Squelette du script | # Squelette du script | ||
| ``` | ``` | ||
| Ligne 88: | Ligne 91: | ||
| - check_mx: Check if an MX entry exist for this domain. True by default | - check_mx: Check if an MX entry exist for this domain. True by default | ||
| - check_server_respond: | - check_server_respond: | ||
| - | |||
| - | ## country | ||
| - | ``` | ||
| - | services.country.country_exists(country: | ||
| - | ``` | ||
| - | From the name of a country, find all the real country that match the name | ||
| - | |||
| - | - country: Name of the country to search | ||
| ## inpi | ## inpi | ||
| Ligne 111: | Ligne 106: | ||
| - siren: the SIREN number of the company | - siren: the SIREN number of the company | ||
| + | |||
| + | ## country | ||
| + | ``` | ||
| + | services.country.country_exists(country: | ||
| + | ``` | ||
| + | From the name of a country, find all the real country that match the name | ||
| + | |||
| + | - country: Name of the country to search | ||
| # Données fournies en entrée du script | # Données fournies en entrée du script | ||
| Ligne 408: | Ligne 411: | ||
| # Lua modules allowed | # Lua modules allowed | ||
| - | - pcall | + | - _G |
| - | - coroutine | + | - _VERSION |
| - assert | - assert | ||
| - | - tostring | ||
| - | - tonumber | ||
| - | |||
| - | - module | ||
| - bit | - bit | ||
| - | - package | + | - collectgarbage |
| - | - error | + | - coroutine |
| - debug | - debug | ||
| - | - rawequal | + | - error |
| - | - unpack | + | |
| - | - pairs | + | |
| - | - table | + | |
| - | - next | + | |
| - math | - math | ||
| - | - _G | + | - module |
| - | - _VERSION | + | - next |
| - | - string | + | |
| - | - type | + | |
| - | - utf8 | + | |
| - | - collectgarbage | + | |
| - os | - os | ||
| - date | - date | ||
| - | - time | ||
| - difftime | - difftime | ||
| + | - time | ||
| + | - package | ||
| + | - pairs | ||
| + | - pcall | ||
| + | |||
| + | - rawequal | ||
| + | - string | ||
| + | - table | ||
| + | - tonumber | ||
| + | - tostring | ||
| + | - type | ||
| + | - unpack | ||
| + | - utf8 | ||
| # Définition des classes utilisés pour les données pivots | # Définition des classes utilisés pour les données pivots | ||
| Ligne 780: | Ligne 783: | ||
| ) | ) | ||
| ``` | ``` | ||
| - | # Définition des objet utilisés dans les scripts | + | # Définition des objets |
| ## DocumentWrapper | ## DocumentWrapper | ||
| - | - document: Document | + | - document |
| - | - name: str | + | - name |
| - | - iteration: int | None | + | - iteration |
| - | - mode: DocumentWrapperModeEnum | + | - mode |
| - | - engine: EngineTypes | + | - engine |
| - | - type: list[DocumentTypeEnum] | + | - type |
| - | - content: dict | null | + | - content |
| - | - input_documents: list[Document] | + | - input_documents |
| - | - is_internal: bool | + | - is_internal |
| - | - step_step_documents: list[StepStepDocument] | + | - step_step_documents |
| - | - ignore_validation: bool | + | - ignore_validation |
| - | - tags: list[object] | + | - tags |
| - | - is_valid: bool | null | + | - is_valid |
| - | - document_provider: str | null | + | - document_provider |
| - | - enrollment_steps: list[EnrollmentStep] | + | - enrollment_steps |
| ## EnrollmentStatusCode | ## EnrollmentStatusCode | ||
| + | - id | ||
| + | - code | ||
| + | - message | ||
| + | - step | ||
| + | - external_method_step | ||
| + | - enrollment | ||
| + | - validation | ||
| + | - document | ||
| + | |||
| + | - pk: _empty | ||
| + | |||
| ## ErrorCodeException | ## ErrorCodeException | ||
| Ligne 805: | Ligne 819: | ||
| ## IdentityDocument | ## IdentityDocument | ||
| - | - definition: list[dict[str | IdentityDocumentPart]] | + | - definition |
| - | - type: MRZDocumentType | + | - type |
| - | - name: str | + | - name |
| - | - line_size: int | + | - line_size |
| - | - nb_line: int | + | - nb_line |
| ## IdentityExtractedDataExtra | ## IdentityExtractedDataExtra | ||
| - | - id_number: str | null | + | - id_number |
| - | - issuing_date: datetime | null | + | - issuing_date |
| - | - expiration_date: datetime | null | + | - expiration_date |
| - | - issuing_country: str | null | + | - issuing_country |
| - | - issuer: str | null | + | - issuer |
| - | - address: str | null | + | - address |
| - | - dmx_id_number: str | null | + | - dmx_id_number |
| - | - dmx_signature_status: str | null | + | - dmx_signature_status |
| - | - mrz_line_1: str | null | + | - mrz_line_1 |
| - | - mrz_line_2: str | null | + | - mrz_line_2 |
| - | - mrz_line_3: str | null | + | - mrz_line_3 |
| - | - nfc_compatible: bool | null | + | - nfc_compatible |
| ## PersonalDetails | ## PersonalDetails | ||
| + | - id | ||
| + | - name | ||
| + | - birth_name | ||
| + | - first_name | ||
| + | - first_names | ||
| + | |||
| + | - address | ||
| + | - zip_code | ||
| + | - city | ||
| + | - country | ||
| + | - phone_number | ||
| + | - birth_date | ||
| + | - gender | ||
| + | - birth_place | ||
| + | - birth_country | ||
| + | - nationality | ||
| + | - identity_valid | ||
| + | - enrollment | ||
| + | |||
| + | - pk: _empty | ||
| + | |||
| # Exemple | # Exemple | ||
| ```lua | ```lua | ||
| Ligne 919: | Ligne 954: | ||
| ``` | ``` | ||
| + | </ | ||