Dicas para trabalhar com APIs

Concluído

As dicas a seguir ajudarão você a ter êxito quando trabalhar com APIs.

• Quando usar GET para chamar o ponto de extremidade, você obterá uma lista de todas as APIs disponíveis.

• Quando usar GET com $metadata para chamar o ponto de extremidade, você obterá uma lista de todas as APIs disponíveis com os metadados correspondentes.

• Quando usar GET com $filter para chamar o ponto de extremidade, você poderá usar as expressões de filtro OData.

• Cada recurso é identificado exclusivamente por meio de uma ID.

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

• A ID do recurso deve ser fornecida na URL quando você estiver tentando ler ou modificar um recurso ou qualquer um de seus filhos. A ID é fornecida entre parênteses () após o ponto de extremidade de API. Por exemplo, para obter os detalhes da empresa CRONUS USA, Inc., você deve chamar usando a lógica a seguir:

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

• Todos os recursos residem no contexto de uma empresa principal, o que significa que a ID da empresa deve ser fornecida na URL para todas as chamadas à API do recurso. Por exemplo, para obter todos os clientes da empresa CRONUS USA, Inc., você deve chamar usando a lógica a seguir:

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