Ir para o conteúdo

URL do serviço API

Introdução

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

O URL de serviço de uma API é o URL usado 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 uma URL de serviço de API

Todos os URLs de serviço de 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 uma URL de serviço de API

O URL de serviço de cada 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 do 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 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 a URL base do seu gateway de API.
  • Use um gateway de API privado Jitterbit com um nome de domínio personalizado (use esta opção se precisar de um gateway de API privado de locatário único).
* Nome da organização Harmony * JBExample

O nome da organização Harmony.

Para licenças de teste que foram 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 suporte Jitterbit ter a palavra TRIAL removido da URL base da organização. Observe que quaisquer usos existentes da URL do serviço serão afetados.
* ID da organização Harmony * 123456 A 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 (veja o campo Prefixo de URL em Ambientes).
Versão 1

A Versão especificada na configuração da API personalizada, serviço OData ou API proxy nestas etapas:

Raiz de serviço customerdog

A Raiz do Serviço especificada na configuração da API personalizada, serviço OData ou API proxy nestas etapas:

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

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