L'API Hello Harel utilise un concept de références partagées pour garder en mémoire les ressources utilisées par les applications externes. Cela vous permet de ne pas vous soucier des identifiants internes de Hello Harel et d'utiliser les vôtres à la place.
Par exemple, lors de la première création d'une commande de vente par POST /api/v1/orders, vous pouvez passer le contact associé à la commande sous la forme suivante :

"contact": {

    "externalReferenceId": "my_own_id",

    "firstName": "Jean",

    "lastName": "Martin",

    "email": "jean.martin@helloharel.com"

  },
Lors des utilisations suivantes, vous pourrez à nouveau passer la référence externalReferenceId et le contact sera automatiquement associé.

Si l'instance Hello Harel vous fournit une liste de ressources partagées (récupérée par GET /api/v1/contact_references par exemple), vous pouvez passer l'ID interne de la resource par la propriété internalReferenceId (qui est un nombre entier) :


"contact": {

    "internalReferenceId": <hello_harel_id>,

    "firstName": "Jean",

    "lastName": "Martin",

    "email": "jean.martin@helloharel.com"

  },

Les ressources concernées sont :

  • Les contacts

  • Les conditionnements

  • Les modes d'expédition.