Le web service Mailmerge

Description du web service Mailmerge permettant de récupérer le fichier lié à une tâche de publipostage

Edit me

Présentation

Le webservice permet de récupérer des informations sur une tâche de publipostage ou le fichier associé à cette tâche. Le fichier peut-être récupéré en totalité ou par morceau.

Construction des URI du webservice

Le web service Mailmerge comprend des URI formées comme suit :

mailmerge/ws/mailing/id_mailing/:id_mailing/output/details

mailmerge/ws/mailing/id_mailing/:id_mailing/output/mailing/dl_by_chunk/:dl_by_chunk/chunk_index/:index/chunk_size/:size/

mailmerge/ws/mailing/id_mailing_externe/:id_mailing_externe/output/:output/dl_by_chunk/:dl_by_chunk/chunk_index/:index/chunk_size/:size/

mailmerge/ws/mailing-model/delete/id/:id_mailing_model/

mailmerge/ws/mailing-model/id/1:id_mailing_model/

Où :

“id, id_mailing ou id_mailing_externe” est suivi de l’id correspondant
“output” peut être égal à details ou mailing selon que l’on veuille récupérer le contenu du fichier ou les détails du modèle
“dl_by_chunk” est suivi de 1 ou true si l’on souhaite récupérer le contenu du fichier en plusieurs morceaux
“chunk_index” est suivi de l’id du morceau du fichier que vous souhaitez récupérer ce paramètre ne peut être supérieur au nombre de chunk
“chunk_size” permet de définir la taille de découpage du fichier. C’est un entier pour définier le nombre d’octet. Il peut être suivi de k, m ou g pour donner l’information en kilo, mega ou giga octet. La taille maximale du chunk est 2M (c’est aussi la valeur par défaut).

Exemples

Détails d’un mailing model

mailmerge/ws/mailing/id_mailing_externe/32/output/details

<root>
    <status>success</status>
    <response>
        <id_data>12658</id_data>
        <id_owner>2</id_owner>
        <id_mailingmodel>372</id_mailingmodel>
        <token>6CFDCEF4</token>
        <creation_date>2018-03-26 12:29:31</creation_date>
        <datasource_row_count>1</datasource_row_count>
        <id_externe>32</id_externe>
    </response>
</root>

Récupération d’un fichier entier

Ici le fichier est récupéré zippé

mailmerge/ws/mailing/id_mailing/21883/output/mailing

<root>
    <status>success</status>
    <response>
        <generated_file>
            contenu du fichier en base 64
        </generated_file>
    </response>
</root>

Récupération d’un fichier par morceaux

Ici les morceaux récupérés ne sont pas zippé

mailmerge/ws/mailing/id_mailing_externe/32/output/mailing/dl_by_chunk/1/chunk_index/1/chunk_size/17000

<root>
    <status>success</status>
    <response>
        <generated_file>
            <id>91062</id>
            <content_type>application/pdf</content_type>
            <file_hash>8308c49f78e150cbd2f31a7da0ad00c9</file_hash>
            <size>210401</size>
            <filename>20180326_1229_mailing.pdf
            </filename>
            <content>
                contenu du chunk en base 64
            </content>
            <hash>0e02cddd3c991755603e37105c28baa1</hash>
            <chunk_index>1</chunk_index>
            <total_chunks>13</total_chunks>
        </generated_file>
    </response>
</root>

mailmerge/ws/mailing/id_mailing_externe/32/output/mailing/dl_by_chunk/1/chunk_index/1/chunk_size/1k

<root>
    <status>success</status>
    <response>
        <generated_file>
            <id>91062</id>
            <content_type>application/pdf</content_type>
            <file_hash>8308c49f78e150cbd2f31a7da0ad00c9</file_hash>
            <size>210401</size>
            <filename>20180326_1229_mailing.pdf
            </filename>
            <content>
                JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBvYmoKPDwvTGVuZ3RoIDMgMCBSL0ZpbHRlci9GbGF0ZURlY29kZT4+CnN0cmVhbQp4nI0ay6orN3J/vsLrATtS6dlgDHeO24vZBQ5kccluMgOBBHI38/tTVSp
                JpW51O/dCH7tVKtX7JZubvfzv46+LuRj8FJZwg0v29pYvP377+OUflz/LGv7/8d+Pf359eAi3eElhwefXvy8/vezFwuXrP9/vwT2u9p4CPePycPcU+Q+Y6OkdJFlb+ZuJMcED7vGVfPJlA2IAXEmG4V6PLK/KKmLJ5WOMj1+//vWxfn38vCHPZYM
                MxCVX8qCR53Gjt4TOw2OpHxM/7SE+b1AUyMgtbfCVnSE8wt0/C9YAPtAhzmdeoxOLVMoL/yLgyC/Kk8HXo8OTvUSINz+cfA/w+Pr9wzKcvaSlwvzx8dPLCYwxGib7m9NQjYeYijif9EDlBFYWpGhJMfSPlz8fVy+CpwVSRP3+iofU20hKmDAATNx
                sR7LTHd/v7hsdiRtPJGXtbdnqaEWBI43Psjt6ZJIMLH4rDCMvIa6N88Zu4zkcM2eI1N2ZJ8xFN93RmSsWGprR8Hd3aJqJ3DXdwpZnzx4jihI2kbm1KLX7GT6PmANibo/8hDlw0x2dOWer2JmMNUVY6a1bXHSHYiYesxuJQKUO9k8HE8xg/3Zj/77
                DwBiwwqEYkJu8P/5YBsZM4FkC7sR0IQJRZxcMvzWgeubTax4gATqxgBEbXsBGV4eURzDB9v2OQdU60r/1pHqbyTwsWwq+iYmf4WHJE/jziyGB3shqgVwHPMRVPdzFQDnkHY0O3RymNMrJ/gGGEol19Y1jKvT55Q3TizTmd1uZGXTq1AGtG/n9fAA
                lKZIJIiA0fuAuWPOet2DjXPosR8QbT/wOrd0ns8k0mE5iHqw5VKjB4oessBi0AgXVjDGBxIOSs4oz+vLn+SbkeY+uNiEQPg88gvjxEXV9GKFQmSXHB6IJz18k/GJI9qm9co9GKjOg1zxVFfhBvieDEK+Y8ClMqfymt22+06kplNRW4+aOBMx2vLY
                j4pRmrHeSfOeUA5peod9uD6L8ExtTYWOLLgdMIyLc48TvFvI0BabsoBdT60BPEJL7q1IpIUXW1nqM+WocoQFcl+UkxvlIFYiyhVY0Yrpb7iFydRTeYVncbW5RSI8SfTJYUwbk8MTNnN2iYBsZsmMtPLnIuVrgAuRqbRTrsQDtjZSupXLSGIiQpna
                C5B3gJzjYihAFQ2c2GkVPy+WYyUXyfTfjowK7VDMDZeQQHc/u0Krvxh94UW0uzEBMu02+ZnFKoZBGFgoD25XmD8OKEC7ouFSrJYKqOqcIpUYVEw==
            </content>
            <hash>05f2f274c55740efb1abe8b34e984c84</hash>
            <chunk_index>1</chunk_index>
            <total_chunks>206</total_chunks>
        </generated_file>
    </response>
</root>

Détail d’une tâche

mailmerge/ws/mailing-model/id/198

<root>
    <status>success</status>
    <response>
        {
            "mailingmodel": [{
                "id_data": "198",
                "name": "MailingModel 1",
                "ws_vzn4_dataquery_id": "142",
                "app_url": "https:\/\/app.voozanoo.net\/project"
            }]
        }
    </response>
</root>

Suppression d’une tâche

Supprime la tâche et tous ses fichiers associés.

mailmerge/ws/mailing-model/delete/id/198

<root>
    <status>success | failed</status>
    <message></message>
</root>