Sommaire

Présentation du Web Service - Distributeurs de boissons chaudes

partner_documentation_intro

Configuration

Endpoint :
https://api.companeo.com/api/v1/partners/create_rfq

Clé d'API à envoyer dans le header de la demande :
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjIyLCJleHAiOjI1MjQ2MDgwMDAsImlzcyI6IklqSXlYMHhRTnpWZk1Ua2kifQ.QBSb0ySvAz5YhcEPA_5IwonGDx4lcGpUaGE55Sm55GE

Paramètre CategoryId à fournir dans la demande : 1463

Requête

partner_documentation_input_intro

Questionnaire

Question : « Nombre de salariés / Visiteurs »

ID : 30148

Obligatoire : oui

Plusieur réponse possible : non


Mappings des id de réponse à envoyer
ID de réponse Description 
25638
 1 - 4 
25639
 5 - 9 
25640
 10 - 19 
25641
 20 - 49 
25642
 50 et plus

Question : « Code postal : »

ID : 25533

Obligatoire : oui

Format de la réponse

Regex : /^[0-9]{5}$/

Question : « Votre email professionnel »

ID : email

Obligatoire : oui

Format de la réponse

Regex : /^[_a-z0-9-]+(\.[_a-z0-9-]+)*@[a-z0-9-]+(\.[a-z0-9-]+)*(\.[a-z]{2,63})$/i

Question : « Téléphone »

ID : phone

Obligatoire : oui

Format de la réponse

Regex : /^(\+33|0033|\+262|00262|\+590|00590|\+594|00594|\+596|00596|0)[\.\- ]?[0-9]([\.\- ]?[0-9]{2}){4}$/

Question : « Nom de la société »

ID : companyName

Obligatoire : oui

Format de la réponse

Regex : /.*\S.*/

Question : « Quelle est votre forme juridique ? »

ID : segment

Obligatoire : oui

Mappings des id de réponse à envoyer
ID de réponse Description 
1
 Société créée (SASU, SARL, etc.) 
CREA
 Société en cours d'immatriculation 
PROJ
 Projet de création 
3
 Un Commerçant ou un Artisan 
4
 Association 
2
 Administration et collectivités 
AUTO
 Auto entrepreneur

Question : « Prénom »

ID : firstname

Obligatoire : oui

Format de la réponse

Regex : ^[a-zA-Z áÁàÀâÂäÄãÃåÅæÆçÇéÉèÈêÊëËíÍìÌîÎïÏñÑóÓòÒôÔöÖõÕøØœŒßúÚùÙûÛüÜ\-']+$

Question : « Nom »

ID : lastname

Obligatoire : oui

Format de la réponse

Regex : ^[a-zA-Z áÁàÀâÂäÄãÃåÅæÆçÇéÉèÈêÊëËíÍìÌîÎïÏñÑóÓòÒôÔöÖõÕøØœŒßúÚùÙûÛüÜ\-']+$

Question : « address »

ID : address

Obligatoire : non

Format de la réponse

Regex : /.*\S.*/

Question : « Commentaire »

ID : comment

Obligatoire : non

Format de la réponse

Regex : /.*\S.*/

Question : « SIRET »

ID : siret

Obligatoire : non

Format de la réponse

Regex : /^[0-9]{14}$/

Question : « Code NAF »

ID : naf

Obligatoire : non

Format de la réponse

Regex : /^(\d){2}[.]?(\d){2}[a-zA-Z]{1}$/

Question : « Effectif de votre société »

ID : employees

Obligatoire : non

Format de la réponse

Regex : /^[\d]+$/

Question : « Ville »

ID : city

Obligatoire : non

Format de la réponse

Regex : /^(.*)$/

Exemple de JSON à envoyer dans la requête

[
    {
        "categoryId": 1463,
        "data": {
            "30148": 25638,
            "25533": "75001",
            "email": "wayne.hotte@test.fr",
            "companyName": "HOTTE INC.",
            "segment": 1,
            "firstname": "Wayne",
            "lastname": "Hotte",
            "phone": "0130926784"
        }
    }
]

Retour

Exemples de réponse en cas de succès

{
    "success": true,
    "data": {
        "message": "partner_creation_success",
        "input_0": {
            "rfq_id": "17410392",
            "cli_id": 8301645
        },
        "input_1": {
            "rfq_id": "17410393",
            "cli_id": 8301646
        }
    },
    "message": "partner_creation_success",
    "errors": []
}

Exemples de réponse en cas d'erreur

{
        "success": false,
        "data": [],
        "message": "partner_error_detected",
        "errors": {
            "input_0": [
                {
                    "code": 6,
                    "data": [
                        28637,
                        27458,
                        27672
                    ],
                    "message": "partner_error_empty_qid"
                }
            ]
        }
    }

Codes de retour HTTP

Le Web Service retourne des codes de retour différent selon l'état du traitement de la demande.

Code de retour Description
200 Toutes les demandes ont été envoyées avec succès
400 Au moins une des demandes envoyées est en erreur
401 Erreur d'authentification

Erreurs

partner_documentation_error_intro

Code d'erreur Description
1 partner_error_authenticate
2 partner_error_account_disabled
3 partner_error_qcp
4 partner_error_language
5 partner_error_categ
6 partner_error_empty_qid
7 partner_error_unknown_qid
8 partner_error_empty_iid
9 partner_error_unknown_iid
10 partner_error_lastname
11 partner_error_firstname
12 partner_error_email_address
13 partner_error_company_name
14 partner_error_zipcode
15 partner_error_phone
16 partner_error_duplicate
17 partner_error_category_id_unknown
18 partner_error_malformed_request
19 partner_error_not_allowed_categories

Exemple d'utilisation avec CURL

Requête

curl --request POST \
https://api.companeo.com/api/v1/partners/create_rfq \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjIyLCJleHAiOjI1MjQ2MDgwMDAsImlzcyI6IklqSXlYMHhRTnpWZk1Ua2kifQ.QBSb0ySvAz5YhcEPA_5IwonGDx4lcGpUaGE55Sm55GE' \
--data '[{"categoryId":1463,"data":{"30148":25638,"25533":"75001","email":"wayne.hotte@test.fr","companyName":"HOTTE INC.","segment":1,"firstname":"Wayne","lastname":"Hotte","phone":"0130926784"}}]' \
-k

Réponse

{
    "success": true,
    "data": {
        "message": "partner_creation_success",
        "input_0": {
            "rfq_id": "17410391",
            "cli_id": 8301644
        }
    },
    "message": "partner_creation_success",
    "errors": []
}