URL del Servicio API¶

Introducción¶

APIs personalizadas, servicios OData y APIs de proxy creados a través de Harmony API Manager se accede mediante la URL de servicio de una API. Esta página describe las partes de una URL de servicio API.

La URL de servicio de una API es la URL utilizada para consumir la API mediante el método de autenticación configurado.

La URL del servicio se puede llamar desde una aplicación o, si la API admite GET, puede pegar la URL en un navegador web para consumir la API manualmente.

Formato de una URL de Servicio API¶

Todas las URLs del servicio API siguen el mismo formato. Las APIs de proxy pueden tener parámetros de ruta de servicio adicionales:

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>

Estos son ejemplos típicos de la URL de servicio de una 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 una URL de Servicio API¶

La URL de servicio de cada API se construye automáticamente con estas partes:

Parte	Ejemplo	Descripción
Protocolo	`https`	El protocolo es siempre `https`.
URL base	`JBExample123456.jitterbit.net`	La URL base. La URL base predeterminada consta del nombre de la organización de Harmony, el ID de la organización de Harmony y el nombre de dominio de la región de Harmony: `<Harmony Organization Name><Harmony Organization ID>.<Harmony Region Domain Name>` Para utilizar un nombre de dominio personalizado como URL base para sus APIs publicadas, puede utilizar uno de estos métodos: Utilice una herramienta de externo como Cloudflare o un proxy DNS para enrutar un nombre de dominio personalizado a la URL base de su puerta de enlace API. Utilice una puerta de enlace API privada Jitterbit con un nombre de dominio personalizado (use esta opción si necesita una puerta de enlace API privada y de un solo inquilino).
* Nombre de la organización Harmony *	`JBExample`	El nombre de la organización Harmony. Para licencias de prueba que se iniciaron antes de 10.64 / 11.2 versión, el nombre de la organización se adjunta con la palabra `TRIAL` Puedes contactar con soporte de Jitterbit tener la palabra `TRIAL` eliminado de la URL base de la organización. Tenga en cuenta que cualquier uso existente de la URL del servicio se verá afectado.
* ID de organización de Harmony *	`123456`	El ID de organización de Harmony.
* Nombre de dominio de la región Harmony *	`jitterbit.net`	La región de Harmony nombre de dominio de la organización Harmony : APAC: `jitterbit.cc` EMEA: `jitterbit.eu` NA: `jitterbit.net`
Prefijo de URL del ambiente	`Development`	El Prefijo de URL especificado en la configuración del ambiente donde se está configurando la API (consulte el campo prefijo de URL en Ambientes).
Versión	`1`	La Versión especificada en la configuración de la API personalizada, el servicio OData o la API proxy en estos pasos: Paso 1: Configuración de configuración de API personalizada Paso 1: Configuración de configuración del servicio OData Paso 1: Configuración básica de configuración de API de proxy
Raíz del servicio	`customerdog`	La Raíz de servicio especificada en la configuración de la API personalizada, el servicio OData o la API proxy en estos pasos: Paso 1: Configuración de configuración de API personalizada Paso 1: Configuración de configuración del servicio OData Paso 1: Configuración básica de configuración de API de proxy
Ruta de servicio (solo API de proxy)	`pet/{petId}/uploadImage`	La Ruta especificada en la configuración de la API de proxy en este paso: Paso 3: Definir servicios y métodos de configuración de API de proxy