Usando GraphQL
1

GraphQL es un lenguaje de consulta moderno que le permite definir la estructura de datos de sus consultas y pedir exactamente lo que quiere y nada más.

Las consultas GraphQL no sólo acceden a las propiedades de un recurso, sino que también siguen sin problemas las referencias entre ellos. Mientras que las típicas APIs REST requieren la carga desde varias URLs, las APIs de GraphQL obtienen todos los datos que su aplicación necesita en una sola solicitud.

Operaciones

Pregunta: Las operaciones READ se realizan mediante consultas GraphQL, éstas no cambian los datos.

Mutación: Usará mutaciones para realizar todas las demás operaciones de modificación de datos.

Tipos de objetos

Los tipos de objetos son conjuntos de campos que se utilizan para definir el conjunto de datos que se pueden consultar desde la API.

GraphQL
consulta {
}

mutación {
}

Campos

Los campos se usan para pedir propiedades específicas de los objetos.

Cada objeto tiene campos que pueden ser consultados por su nombre para poder consultar las propiedades que necesita.

GraphQL
query {
EnjinToken {
id
}
}

Argumentos

Puede determinar el valor de retorno de una consulta pasándole argumentos. Esto reduce los resultados y le permite obtener sólo lo que busca.

En el siguiente ejemplo, el objeto es "token", el campo solicitado es "name", el argumento es "id".

GraphQL
query GetToken($name: String) {
token: EnjinTokens(
  name: $name
) {
  id
}
}

GraphiQL: La interfaz visual de GraphQL

Probablemente la característica más fácil de usar de GraphQL es su interfaz visual, una herramienta dentro del navegador para escribir, validar y probar las consultas de GraphQL.

Antes de consultar la API, se recomienda ejecutar las consultas a través de la interfaz visual para asegurarse de que son correctas y de que los datos que se devuelven son los que usted espera.

Puede utilizar las siguientes interfaces web de GraphiQL para interactuar con la API:

Aplicación de escritorio GraphiQL

También puede descargar la versión de escritorio de GraphiQL para interactuar con la API

Descarga para Windows: https://www.electronjs.org/apps/graphiql

Aquí están los puntos finales a usar dentro de la aplicación de escritorio:

Consulta de los tipos de objetos de Enjin

La consulta es la forma de pedir datos, es similar a la acción GET en las APIs basadas en REST.

Aquí hay una lista de los tipos de objetos Enjin que pueden ser consultados a través de la API:

  • EnjinApp: Utilice esta consulta para obtener información sobre una aplicación en la plataforma Enjin.
  • EnjinApps: Utilice esta consulta para obtener información sobre múltiples aplicaciones en la plataforma Enjin.
  • EnjinBalances: Use esta consulta para obtener información sobre los saldos almacenados en la Plataforma Enjin.
  • EnjinIdentidades: Utilice esta consulta para obtener información sobre las identidades almacenadas en la plataforma de Enjin.
  • EnjinIdentity: La identidad de un usuario para un juego.
  • EnjinOauth: Utiliza esta consulta para iniciar la sesión de los usuarios y obtener los tokens de acceso oAuth.
  • EnjinPlatform: Utilice esta consulta para obtener información sobre un proyecto en la Plataforma Enjin.
  • EnjinTokenEvents: Usa esto para consultar los eventos simbólicos que han sido registrados por la Plataforma Enjin.
  • EnjinToken: Usa esta consulta para obtener datos de los tokens.
  • EnjinTransactions: Utilice esto para consultar las solicitudes de transacciones.
  • EnjinUser: Use esta consulta para obtener información sobre un usuario de la Plataforma Enjin.
  • EnjinUsers: Use esto para consultar los datos de los usuarios en la plataforma de Enjin.
  • EnjinWallet: Usa esta consulta para obtener datos de la cartera.

Tipos de objetos mutantes de Enjin

Mutar en GraphQL es la forma de modificar los datos, es el término utilizado para incluir todas las funciones no API que no sean GET. Esto incluye funciones como PUT, POST y DELETE con las que puede estar familiarizado desde las API basadas en REST.

A diferencia de la consulta, la mutación requiere añadir todos los argumentos a la mutación. Después de que se ejecuta, se pueden consultar los valores del objeto después de que la mutación haya tenido lugar.

Hay diferentes tipos de tipos de objetos Enjin que pueden ser mutados a través de la API.

Aquí hay una lista de los tipos de objetos Enjin que pueden ser mutados:

  • CreateEnjinApp: Esta mutación permite crear un nuevo proyecto en la plataforma Enjin.
  • UpdateEnjinApp: Esta mutación permite actualizar los detalles de un proyecto como el nombre o la imagen.
  • Borrar la aplicación de Benjamin: Esta mutación permite borrar un proyecto de la plataforma Enjin. Esto sólo puede ser realizado por el creador del proyecto.
  • CreateEnjinIdentity: Esta mutación permite crear una nueva identidad para los usuarios de la plataforma Enjin.
  • UpdateEnjinIdentity: Esta mutación permite actualizar una identidad. Esta mutación también se utiliza para vincular una cartera con un mensaje firmado.
  • DeleteEnjinIdentity: Esta mutación permite borrar una identidad de la plataforma Enjin. También puedes usar esta mutación para desvincular una identidad de una cartera.
  • CreateEnjinRequest: Esta mutación permite crear una nueva solicitud de transacción para enviar a la blockchain, y es la principal forma de interactuar con los diferentes métodos de contratos inteligentes. Al crear solicitudes de transacción, es importante utilizar el ID de identidad correcto, ya que la dirección de Ethereum que se almacena en él se utilizará como "creador" de la solicitud y, por tanto, debe coincidir con el creador o propietario del token que se está manipulando. En el caso de una solicitud de creación, el ID se convertirá en el "creador" del nuevo token.
  • UpdateEnjinRequest: Esta mutación permite actualizar una solicitud de transacción pendiente que aún no ha sido firmada y emitida a la blockchain.
  • BorrarSolicitudDeTransacción: Esta mutación permite cancelar una solicitud de transacción que aún no ha sido firmada y difundida a la blockchain.
  • CreateEnjinUser: Esta mutación le permite crear un jugador para su aplicación en la plataforma de Enjin.
  • Desencadena la aplicación: Esta mutación permite desvincular una cartera de un proyecto.
  • Inutilización de identidades: Esta mutación permite desvincular una cartera de una identidad.
  • InvalidarTokenMetadata: Invalidar los metadatos de una ficha al instante.

Puede encontrar información completa sobre qué datos pueden ser consultados y mutados usando estos tipos de objetos en el Explorador de Documentación de GraphiQL.

Para encontrarla, vaya a la página Interfaz visual de GraphiQL y haga clic en el botón "Docs " en la esquina superior derecha.

Consulta de variables

Puede observar en nuestra documentación que proporcionamos ejemplos de nuestras consultas y mutaciones que puede utilizar y que a menudo contienen vairables en su interior. Puede consultar estas variables simplemente pasando los datos en la sección "Variables de consulta" en la parte inferior de la página.

Simplemente deslícese por la barra inferior (Variables de consulta) y comience a introducir las variables y sus respectivos datos.

Plataforma de enlace de Enjin

Navegando por el esquema

En el lado derecho, debería haber un panel de documentación para expandir y buscar todas las solicitudes y parámetros que se pueden utilizar. Vea aquí la documentación sobre Consultas y Mutaciones. Las Consultas son solicitudes de información del servidor, donde las Mutaciones son solicitudes que modifican los datos del lado del servidor.

Haciendo una solicitud

En el panel izquierdo (superior), usted entraría en su solicitud para ser hecha a la Nube de Enjin. Presione el botón "Play" en la parte superior para enviar esa solicitud, y usted recibirá una respuesta en el panel derecho, a veces una notificación aparecerá en su cartera de desarrollo para firmar una transacción en función de la solicitud realizada.

Anterior
siguiente
En esta página