Ir para o conteúdo

URL do Serviço da API

Introdução

APIs personalizadas, serviços OData e APIs proxy criadas por meio do Harmony API Manager são acessados usando um URL de serviço da API. Esta página descreve as partes de um URL de serviço de API.

A URL de serviço de uma API é a URL usada para consumir a API usando o método de autenticação configurado.

A URL do serviço pode ser chamada de um aplicativo ou — se a API suportar GET — você pode colar a URL em um navegador da Web para consumir a API manualmente.

Formato de um URL de Serviço de API

Todos os URLs de serviço da API seguem o mesmo formato. As APIs de proxy podem ter parâmetros de caminho de serviço adicionais:

Custom API or OData Service
<Protocol>://<Base URL>/<Environment URL Prefix>/<Version>/<Service Root>
Proxy API
<Protocol>://<Base URL>/<Environment URL Prefix>/<Version>/<Service Root>/<Service Path>

Estes são exemplos típicos de URL de serviço de uma API:

Custom API or OData Service
https://JBExample123456.jitterbit.net/Development/1/customer
Proxy API
https://JBExample123456.jitterbit.net/Development/1/dog/pet/{petId}/uploadImage

Partes de um URL de Serviço de API

Cada URL de serviço da API é construído automaticamente com estas partes:

Parte Exemplo Descrição
Protocolo https O protocolo é sempre https.
URL Base JBExample123456.jitterbit.net

A URL base. A URL base padrão consiste no nome da organização Harmony, ID da organização Harmony e nome de domínio da região Harmony:

<Harmony Organization Name><Harmony Organization ID>.<Harmony Region Domain Name>

Para usar um nome de domínio personalizado como o URL base para suas APIs publicadas, você pode usar um destes métodos:

  • Use uma ferramenta de externo, como Cloudflare ou um proxy DNS para rotear um nome de domínio personalizado para o URL base de seu Gateway de API.
  • Use um Jitterbit Gateway de API Privado com um nome de domínio personalizado (use esta opção se precisar de um Gateway de API privado e de locatário único).
*Nome da Organização Harmony * JBExample

O nome da organização Harmony.

Para licenças de teste iniciadas antes de 10.64 / 11.2 lançamento, o nome da organização é anexado com a palavra TRIAL. Você pode entrar em contato com o Suporte Jitterbit ter a palavra TRIAL removido do URL base da organização. Observe que qualquer uso existente da URL do serviço será afetado.
* ID da Organização Harmony * 123456 O ID da organização Harmony.
*Nome de Domínio da Região Harmony * jitterbit.net

A região da Harmony nome de domínio da organização Harmony :

  • APAC: jitterbit.cc
  • EMEA: jitterbit.eu
  • ** NA:** jitterbit.net
Prefixo de URL do ambiente Development O Prefixo de URL especificado na configuração do ambiente onde a API está sendo configurada (consulte o campo Prefixo de URL em Ambientes).
Versão 1

A Versão especificada na configuração da API Customizada, Serviço OData ou proxy de API nestas etapas:

Serviço Raiz customerdog

A raiz de serviço especificada na configuração da API Customizada, Serviço OData ou proxy de API nestas etapas:

Caminho do serviço (somente proxy de API ) pet/{petId}/uploadImage

O Caminho especificado na configuração da proxy de API nesta etapa: