URL do Serviço de API¶
Introdução¶
APIs personalizadas, serviços OData e APIs de 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.
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 a partir 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 de API seguem o mesmo formato. As APIs proxy podem ter parâmetros de caminho de serviço adicionais:
<Protocol>://<Base URL>/<Environment URL Prefix>/<Version>/<Service Root>
<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:
https://JBExample123456.jitterbit.net/Development/1/customer
https://JBExample123456.jitterbit.net/Development/1/dog/pet/{petId}/uploadImage
Partes de um 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 | O URL base. O URL base padrão consiste no nome da organização Harmony, no ID da organização Harmony e no nome de domínio da região Harmony:
Para usar um nome de domínio personalizado como URL base para suas APIs publicadas, você pode usar um destes métodos:
|
* Nome da Organização Harmony * | JBExample | O nome da organização Harmony. Para licenças de avaliação iniciadas antes de 10.64 / 11.2 lançamento, o nome da organização é anexado com a palavra |
* 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 Harmony nome de domínio da organização Harmony :
|
Prefixo do 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, do serviço OData ou da API proxy nestas etapas: |
Raiz de serviço | customerdog | A Raiz de Serviço especificada na configuração da API personalizada, do serviço OData ou da API de proxy nestas etapas: |
Caminho do serviço (somente API de proxy) | pet/{petId}/uploadImage | O Path especificado na configuração da API do proxy nesta etapa: |