Saltar al contenido

URL del Servicio API

Introducción

APIs personalizadas, servicios OData y APIs de proxy creadas 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 del 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 es compatible con GET, puede pegar la URL en un navegador web para consumir la API manualmente.

Formato de una URL de Servicio API

Todas las URLs de servicio de 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 del 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 del servicio de cada API se construye automáticamente a partir de 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 usar un nombre de dominio personalizado como URL base para sus APIs publicadas, puede usar uno de estos métodos:

  • Use una herramienta de externo como Cloudflare o un proxy DNS para enrutar un nombre de dominio personalizado a la URL base de su Pasarela de API.
  • Utilice una Jitterbit Pasarela de API Privada con un nombre de dominio personalizado (utilice esta opción si necesita una Pasarela de API privada de un solo arrendatario).

* 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 lanzamiento, el nombre de la organización se adjunta con la palabra TRIAL. Puede ponerse en contacto 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 la organización de Harmony.
* Nombre de dominio de la región de 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 de ambiente Development El Prefijo URL especificado en la configuración del ambiente donde se está configurando la API (ver el campo Prefijo URL en Ambientes).
Versión 1

La Versión especificada en la configuración de la API Personalizada, el Servicio OData o la proxy de API en estos pasos:

Raíz de servicio customerdog

La raíz del servicio especificada en la configuración de la API Personalizada, el Servicio OData o la proxy de API en estos pasos:

Ruta de servicio (solo proxy de API ) pet/{petId}/uploadImage

La ruta especificada en la configuración de la proxy de API en este paso: