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 mediante 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 identificador del recurso debe indicarse en la URL cuando se intente leer o modificar un recurso o cualquiera de sus recursos secundarios. El ID se indica entre paréntesis () después del endpoint de la 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., realizaría la llamada usando la siguiente lógica:

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

  • Especifique el encabezado de solicitud Accept-Language para controlar el idioma de la respuesta, como los mensajes de error, y el formato regional de valores como fechas y horas.

  • Especifique el encabezado de solicitud Data-Access-Intent con el valor ReadOnly para leer datos de una réplica de la base de datos, lo que reduce la carga en la base de datos principal. Las solicitudes de modificación, como POST, PATCH o DELETE, solo admiten el valor ReadWrite.