Suggerimenti per l'uso delle API

  • 5 minuti

I seguenti suggerimenti aiuteranno ad avere successo nell'uso delle API.

  • Quando si chiama l'endpoint tramite GET, si ottiene un elenco di tutte le API disponibili.

  • Quando si chiama l'endpoint tramite GET con $metadati, si ottiene un elenco di tutte le API disponibili e i rispettivi metadati.

  • Quando si chiama l'endpoint tramite GET con $filter, si possono usare le espressioni filtro OData.

  • Ogni risorsa è identificata in modo univoco tramite 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 risorsa deve essere fornito nell'URL quando si tenta di leggere o modificare una risorsa o uno degli elementi figlio. L'ID viene fornito tra parentesi () dopo l'endpoint API. Ad esempio, per ottenere i dati della società CRONUS USA, Inc., è necessario eseguire la chiamata utilizzando la seguente logica:

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

  • Tutte le risorse risiedono nel contesto di una società madre, il che significa che l'ID società deve essere fornito nell'URL per tutte le chiamate API delle risorse. Ad esempio, per ottenere tutti i clienti della società CRONUS USA, Inc., è necessario eseguire la chiamata utilizzando la seguente logica:

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