Sugerencias para trabajar con API

  • 5 minutos

Las siguientes sugerencias le servirán de ayuda para tener éxito cuando trabaje con las API.

  • Cuando llame al punto de conexión a través de GET, obtendrá una lista de todas las API disponibles.

  • Cuando llame al punto de conexión a través de GET con $metadata, obtendrá una lista de todas las API disponibles con sus metadatos.

  • Cuando llame al punto de conexión a través de GET con $filter, puede usar las expresiones de filtro de OData.

  • Cada recurso se identifica de manera única a través de 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": ""
        }
    ]
}

  • El id. de recurso debe proporcionarse en la URL cuando intente leer o modificar un recurso o cualquiera de sus elementos secundarios. El id. se proporciona entre paréntesis () después del punto de conexión de API. Por ejemplo, para obtener los detalles de la empresa CRONUS USA, Inc., debe llamar utilizando la siguiente lógica:

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

  • Todos los recursos se encuentran en el contexto de una empresa matriz, lo que significa que el id. de la empresa debe proporcionarse en la URL para todas las llamadas a la API de recursos. Por ejemplo, para obtener todos los clientes de la empresa CRONUS USA, Inc., llamaría utilizando la siguiente lógica:

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