La API GraphQL tiene habilitada la Introspección, lo que permite a los usuarios consultar la propia API para obtener más información sobre ella. Consulte más documentación sobre esto aquí. Recomendamos usar Altair (docs) y Postman (docs) como clientes para ver qué está disponible dentro de la API.
Obtener la clave API GraphQL en MEX:
Para usar la API GraphQL, primero deberá generar una clave API. Esto se puede hacer navegando a Configuración > Usuarios > Seleccione el usuario para el que desea crear una clave API > Seleccione Generar nueva clave API GraphQL de MEX. Una vez hecho esto, es posible revelar o copiar la clave API.
En caso de que desee revocar una clave API GraphQL, simplemente navegue nuevamente al usuario y seleccione el botón Revocar clave.
Cómo usarla:
La API GraphQL para su instancia de MEX está disponible en https://{yourDomain}/graphql.
Autentíquese usando el encabezado X-API-KEY con una clave API generada desde MEX.
Opcionalmente, proporcione el encabezado X-REGION-ID para limitar las consultas y mutaciones a una región específica. Solo se pueden especificar regiones a las que el usuario autenticado tenga acceso.
Paginación: Tamaño de página predeterminado = 100, Tamaño máximo de página = 100.
Ejemplo en Postman:
Tenga en cuenta - El valor de la clave API y la URL base se han configurado como variables en las imágenes de ejemplo. Para información sobre cómo hacerlo, consulte estos documentos - Almacenar y reutilizar valores usando variables
En Postman, configure la URL (https://{yourDomain}/graphql) y la clave API. La clave API se puede ingresar en la pestaña Autorización. Cuando esté en la pestaña Autorización, bajo Tipo de autenticación seleccione "Clave API". Luego, en el campo Clave ingrese "X-API-Key" junto con su clave API en el campo Valor.
Una vez completado esto, navegue a la pestaña Esquema para verificar que está Usando la introspección GraphQL.
Una vez que se esté utilizando la introspección, navegue a la pestaña Consulta que le permitirá construir sus propias consultas. Por ejemplo, esta configuración a continuación devuelve una lista de números y descripciones de órdenes de trabajo.