Création d'une nouvelle souscription

1. Authentification

Ce qu'il faut faire : Envoyez vos identifiants (clientId et clientSecret) via une requête pour obtenir un token.
Ce que vous recevrez : Un token et un serviceAccount.id. Gardez-les pour les étapes suivantes.

{
   "serviceAccount":{
      "id":"b97dc620-eb44-40e1-882b-e6006e3057ad",
      "clientId":"...",
      "clientSecret":"..."
   },
   "token":"...",
   "refreshToken":"..."
}

2. Récupérer les informations des magasins

Ce qu'il faut faire : Avec le token, demandez la liste des magasins liés à votre compte.
Ce que vous recevrez : Une liste de magasins avec leurs id et les id de leurs canaux de vente.

[
   {
      "id":"7ccfdc18-76cf-40d9-a905-e500117cf8be",
      "name":"Neat Demo",
      "legalName":"Neat SAS",
      "legalTerms":{
         "siret":null,
         "orias":null,
         "capital":null,
         "rcs":null,
         "naf":null
      },
      "settings":{
         "logoUrl":"",
         "faviconUrl":"",
         "primaryColor":"#FB4722",
         "secondaryColor":null,
         "whiteBrandEmail":null,
         "emailFrom":null
      },
      "address":{
         "streetNumber":"12",
         "street":"Avenue des Amandiers",
         "city":"Bordeaux",
         "zipCode":"33000",
         "country":"France"
      },
      "websiteUrl":"https://neat.eu/",
      "validationStatus":"Validated",
      "billingInformations":null,
      "salesChannels":[
         {
            "id":"058bd359-af24-4164-a63d-0a36b16fdfdd",
            "name":"Audio en magasin"
         },
         {
            "id":"748f9f46-b42e-4c94-b74b-98143330d626",
            "name":"Vélo"
         },
         {
            "id":"dc129e3f-9a9c-4d54-a243-05001296a6e4",
            "name":"Voyage web"
         }
      ]
   }
]

3. Liste des contrats et méthodes de paiement

Ce qu'il faut faire : Utilisez l'id d'un canal de vente pour obtenir les contrats distributeurs et les méthodes de paiement disponibles.
Ce que vous recevrez : Des informations sur les paymentMethods et contracts. Choisissez une méthode de paiement et notez son id et celui d'un contrat.

{
   "id":"058bd359-af24-4164-a63d-0a36b16fdfdd",
   "name":"Audio en magasin",
   "type":"PointOfSales",
   "askEmailVerificationCode":false,
   "isSendEmailEnabled":false,
   "isCertificateGenerationDisabled":false,
   "paymentMethods":[
      {
         "id":"226bc0e4-3e3d-4bb8-a779-460ce7f2cd40",
         "type":"CreditCard",
         "name":"shop",
         "disabled3DS":false
      }
   ],
   "contracts":[
      "89afc069-5827-4ce4-b294-047648dca8b6"
   ],
   "store":"7ccfdc18-76cf-40d9-a905-e500127cf8be",
   "dataProviderConfiguration":null,
   "requestDocumentsSignature":false,
   "rank":"0|i00007:",
   "disabled":false
}

4. Détails des contrats pour un canal de vente

Ce qu'il faut faire : Demandez les détails des contrats en utilisant l'id du canal de vente.
Ce que vous recevrez : Des détails sur chaque service offert, y compris leurs noms et champs de service.

[
  {
    "id": "89afc069-5827-4ce4-b294-047648dca8b6",
    "status": "Active",
    "docusignId": null,
    "commissionRate": 10,
    "store": {
      ...
    },
    "product": {
      "id": "1dea030e-c099-459d-8bad-c771fffc1f94",
      "createdAt": "2023-04-19T17:02:16.000Z",
      "updatedAt": "2023-10-03T14:50:14.000Z",
      "name": "Audioprotect option",
      "description": "Produit audio",
      "status": "enabled",
      "protectionDays": 1460,
      "carenceDays": 0,
      "trialDays": 0,
      "certificateType": "Default",
      "beneficiariesNumber": 1,
      "multiplyByBeneficiaries": false,
      "retractPeriod": 0,
      "originalVersion": { ... },
      "contracts": [],
      "pricings": [ ... ],
      "services": [
        {
          "id": "7ad9690b-05d6-4185-9d88-d82aa0391a1a",
          "name": "Perte, Vol, Casse Prothèse Auditive en option",
          "priceFixAmount": 40,
          "pricePercent": 0,
          "tax": 9,
          "billingCyclePeriod": "one_shot",
          "billingCycleCount": 0,
          "provider": { ... },
          "serviceFields": [
            {
              "id": "bae06dbf-b2f0-4e6b-8c19-ce12ea9a5245",
              "title": "marque",
              "name": "marque",
              "required": true,
              "type": "string",
              "options": [],
              "description": "marque de l'appareil",
              "rank": null
            },
            {
              "id": "f5c997cf-3154-41be-afaf-2feab1a3f734",
              "title": "modele",
              "name": "modele",
              "required": true,
              "type": "string",
              "options": [],
              "description": "modele de l'appareil",
              "rank": null
            },
            {
              "id": "6aacd5bc-9684-405a-8571-b8b867304bf3",
              "title": "serial",
              "name": "serial",
              "required": true,
              "type": "string",
              "options": [],
              "description": "N° de série",
              "rank": null
            },
            {
              "id": "3b99f411-8092-4e56-a2c5-e27ebb96c317",
              "title": "prix ttc",
              "name": "prix ttc",
              "required": true,
              "type": "number",
              "options": [],
              "description": "Prix facturé TTC",
              "rank": null
            },
            {
              "id": "13bc8c88-7627-46fb-8916-e0caef02590f",
              "title": "Oreille",
              "name": "Oreille",
              "required": true,
              "type": "dropdown",
              "options": [
                "gauche",
                "droite"
              ],
              "description": "Oreille de l'appareil",
              "rank": null
            },
            {
              "id": "ec2f6cc8-dca0-4d86-9057-cd056370b9e3",
              "title": "date facturation",
              "name": "date facturation",
              "required": true,
              "type": "datetime",
              "options": [],
              "description": "Date de facturation",
              "rank": null
            },
            {
              "id": "1965ada9-e258-45bc-a701-04e31fe256f0",
              "title": "essai",
              "name": "essai",
              "required": true,
              "type": "checkbox",
              "options": [],
              "description": "période d'essai de 40J",
              "rank": null
            }
          ]
        }
      ],
      "files": [ ... ],
      "deletedAt": null,
      "security": null,
      "nextVersion": null,
      "originalId": "1dea030e-c099-459d-8bad-c771fffc1f94"
    },
    "brokerFeeRules": [],
    "contractMailTemplates": [],
    "files": [],
    "contractDocumentTemplates": []
  }
]

5. Calcul du prix du contrat

Ce qu'il faut faire : Avec l'id du contrat, demandez le prix en spécifiant les détails nécessaires.
Ce que vous recevrez : Le montant total à payer pour la souscription.

{"amount":70}

6. Souscrire au contrat

Ce qu'il faut faire : Envoyez une requête avec toutes les informations requises pour créer la souscription.
Ce que vous recevrez : Un id de souscription, à enregistrer pour des usages futures.

{"id": "89afc069-5827-4ce4-b294-047648dca8b2"}