Conseils d’utilisation des API

  • 5 minutes

Les conseils suivants vous aideront à réussir lorsque vous utilisez des API.

  • Lorsque vous appelez le point de terminaison au moyen de GET, vous obtenez une liste de toutes les API disponibles.

  • Lorsque vous appelez le point de terminaison au moyen de GET avec $metadata, vous obtenez une liste de toutes les API disponibles avec leurs métadonnées.

  • Lorsque vous appelez le point de terminaison au moyen de GET avec $filter, vous pouvez utiliser les expressions de filtre OData.

  • Chaque ressource est identifiée de manière unique grâce à un ID.

    {
    "@odata.context": "<endpoint>/$metadata#companies",
    "value": [
        {
            "id": "bb6d48b6-c7b2-4a38-9a93-ad5506407f12",
            "systemVersion": "18453",
            "name": "CRONUS USA, Inc.",
            "displayName": "CRONUS USA, Inc.",
            "businessProfileId": ""
        }
    ]
}

  • L’ID de la ressource doit être fourni dans l’URL lorsque vous essayez de lire ou de modifier une ressource ou l’un de ses enfants. L’ID est fourni entre parenthèses () après le point de terminaison d’API. Par exemple, pour obtenir les détails de la société CRONUS USA, Inc., vous devez appeler en utilisant la logique suivante :

    <endpoint>/companies(bb6d48b6-c7b2-4a38-9a93-ad5506407f12)/

  • Toutes les ressources vivent dans le contexte d’une société mère, ce qui signifie que l’ID de la société doit être fourni dans l’URL pour tous les appels d’API de ressources. Par exemple, pour obtenir tous les clients de la société CRONUS USA, Inc., vous devez appeler en utilisant la logique suivante :

    <endpoint>/companies(bb6d48b6-c7b2-4a38-9a93-ad5506407f12)/customers