Saltar al contenido

URL del servicio API

Introducción

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

La URL de servicio de una API es la URL que se utiliza para consumir la API utilizando 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 la URL de un servicio API

Todas las URLs de servicios 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 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 la URL de un 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 Harmony, el ID de la organización Harmony y el nombre de dominio de la región 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 puerta de enlace de API.
  • Use una puerta de enlace de API privada Jitterbit con un nombre de dominio personalizado (use esta opción si necesita una puerta de enlace API privada y de inquilino único).
* Nombre de la Organización Harmony * JBExample

El nombre de la organización Harmony.

Para las licencias de prueba que se iniciaron antes de la versión 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 se verán afectados todos los usos existentes de la URL del servicio.
* Identificación de la organización Harmony * 123456 El ID de la organización Harmony.
* Nombre de dominio de la región Harmony * jitterbit.net

La región de la 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 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 API proxy en estos pasos:

Raíz del servicio customerdog

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

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

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