Docs de l'API 3.1Docs de l'API 4.0 SimpleDocs de l'API 4.0

Migrer de 3.1 à 4.0

Information importante à mettre à jour de 3.1 à 4.0 de l'API.

Veuillez vous assurer d'avoir migré vers 3.1 d'abord avant de migrer vers 4.0 3.1 Guide de migration

Changements importants

POST
{base_url}/api/v4/
  • Mettre à jour les demandes à .../api/v4/... Au lieu de .../api/v3.1/... .
POST
{base_url}/api/v4/site/{site_id}/customer/addUpdate
  • Champs de contact de niveau racine ( first_name , last_name , email , mobile_phone ) doit maintenant être fourni à l'intérieur d'un primary_contact objet, ou comme entrées dans le contacts Tableau.
  • Le notification_options Champ a été supprimé. Les préférences de notification sont maintenant gérées au niveau du contact.
POST
{base_url}/api/v4/site/{site_id}/invoice/addUpdate
  • Les champs bill_email , bill_email_cc , bill_email_bcc , et billing_address ont été remplacés par le bill_to Objet.
  • Le shipping_address Champ a été remplacé par le sold_to Objet.
Produits → Articles
  • Le point de terminaison Produits a été renommé en Articles. Mettez à jour les demandes vers site/{site_id}/item/addUpdate Au lieu de site/{site_id}/product/addUpdate .
    • Affectant
    • POST
      {base_url}/api/v4/site/{site_id}/item/addUpdate
Pièces jointes
  • Le attachments Champ (une liste simple d'URL) a été remplacé par le attachment_refs Objet, qui organise les pièces jointes en internal , external , et source_pdf Sous-champs.
    • Affectant
    • POST
      {base_url}/api/v4/site/{site_id}/invoice/addUpdate
    • POST
      {base_url}/api/v4/site/{site_id}/customer/addUpdate
    • POST
      {base_url}/api/v4/site/{site_id}/subscription/addUpdate
Identification de l'enregistrement
  • Dossiers sont maintenant identifiés et mis à jour par _id Au lieu de external_id .

Nouveau en 4.0

POST
{base_url}/api/v4/site/{site_id}/contact/addUpdate
  • Les contacts sont maintenant des enregistrements de première classe. Utilisez les points de terminaison des contacts pour créer, récupérer et gérer les contacts de manière indépendante des clients.
POST
{base_url}/api/v4/site/{site_id}/invoice/addUpdate
  • Un nouveau bill_to_customer Champ permettant de facturer un client différent (par exemple, le parent) au lieu du client principal sur la facture.