Finish pixelbuy api schema version 1

Author: Rubenicos

docs/default/developers/schema.md

@@ -0,0 +1,86 @@
+---
+sidebar_position: 2
+title: Schema
+description: PixelBuy web API schema.
+---
+
+To allow people make its own website and connect it with PixelBuy, a format to get website data is provided.
+
+## REST API
+
+Make your site serve data with the typical `GET` and `POST` process.
+
+Json content is used to explain the format.
+
+### Authentication
+
+Every website must provide a "secret", an API key to allow the user to get information from the website API.
+
+PixelBuy is compatible with a variety of authentication formats:
+
+* Query parameters, by providing the secret as a query parameter in the same URL.
+* Header property, by providing the secret as a http header in every connection.
+* Basic authentication, by passing the secret in a Basic authentication header in every connection.
+
+### Version 1
+
+**error:** The response to communicate an error.
+
+```json5
+{
+  "error": "error_message_code",
+  "message": "An error has occur",
+  "status": 404,
+}
+```
+
+**(GET) order:** A store order, the player can be provided by only its name if you don't want to provide the UUID.
+
+```json5
+{
+  "id": 1234, // Order numeric ID / transaction number
+  "date": "1970-01-25", // ISO-8601 formatted
+  "player": "7ca003dc-175f-4f1f-b490-5651045311ad:Rubenicos", // [<uuid>:]<name>
+  "execution": "BUY", // Optional, the value must be BUY, RECOVER or REFUND
+  // The items can be empty if execution is RECOVER or REFUND
+  "items": [
+    {
+      "product": 55, // Optional, it's the product identifier, can be any type of object
+      "id": "super-pickaxe", // The item identifier configured on PixelBuy items
+      "amount": 1, // The amount of items of this type, must be an integer number
+      "price": 2.49, // The real amount of money spend on this item(s)
+    },
+    {
+      "product": 94,
+      "id": "eco-bundle",
+      "amount": 6,
+      "price": 5.04,
+    }
+  ]
+}
+```
+
+**(GET) server:** A server information.
+
+```json5
+{
+  // Orders that should be processed by PixelBuy
+  "pending_orders": [
+    {
+      // Order object...
+    },
+    {
+      // Order object...
+    }
+  ],
+  "next_check": 60, // Optional, the amount of seconds to wait until make the next check
+}
+```
+
+**(POST) update:** Communicate to store a server update.
+
+```json5
+{
+  "processed_orders": [ 1234, 6727, 1897 ], // Order IDs that must be removed from server pending orders
+}
+```

docs/default/store/web-supervisor.md

@@ -4,12 +4,17 @@ title: Web supervisor
 description: How to setup PixelBuy web supervisors.
 ---
 
+```mdx-code-block
+import DocCard from '@theme/DocCard';
+```
+
 The web supervisor interface is a type of system that retrieves data from a web store to apply any necessary delivery inside Minecraft server.
 
 ## Types
 
 PixelBuy currently aims to support some delivery concepts:
 
+* `PIXELBUY` - Website compatible with PixelBuy web API format.
 * `WOOMINECRAFT` - Self-hosted WordPress using **WooMinecraft** plugin.
 * `TEBEX` - BuyCraft-like delivery from **Tebex** store.
 
@@ -18,10 +23,60 @@ PixelBuy currently aims to support some delivery concepts:
 Any web supervisor has common configuration paths.
 
 ```yaml
+Type: PIXELBUY
 Group: 'servername'
+URL: 'https://shop.mysite.com'
 ```
 
+* `type` - The type of web supervisor.
 * `group` - Is the server associated with the name that the supervisor is looking for orders.
+* `url` - Is the store url.
+
+## PixelBuy
+
+The PixelBuy web supervisor retrieves information from a site compatible with PixelBuy web API schema:
+
+```mdx-code-block
+<DocCard item={{
+  type: "link",
+  href: "/pixelbuy/developers/schema/",
+  label: "Schema",
+  description: "PixelBuy web API schema"
+  }}
+/>
+```
+
+This supervisor also came with its own configuration.
+
+```yaml
+    Version: 1
+    Format:
+      Server: '{url}/api/server/{key}'
+      Order: '{url}/api/order/{key}'
+    Rest:
+      Check-Interval: 30
+      Auth: PARAMS
+      Property: 'secret'
+      Secret: ''
+```
+
+* `version` - The version of PixelBuy schema.
+* `format.server` - The URL format to get server information (`{key}` will be replaced with server group).
+* `format.order` - The URL format to get order information (`{key}` will be replaced with order ID).
+* `rest.check-interval` - The interval in seconds to check new orders, set to `DETECT` to use a provided one by REST API.
+* `rest.auth` - The authentication type to connect with REST API.
+* `rest.property` - The property name, this both apply to `PARAMS` and `HEADER` authentication.
+* `rest.secret` - The secret key that is used to get information.
+
+### Format version
+
+* **Version 1:** Initial PixelBuy web API version, no changes.
+
+### Auth types
+
+* `PARAMS` - Use query parameters to provide the secret.
+* `HEADER` - Use header property to provide the secret.
+* `BASIC` - Use HTTP Basic authorization.
 
 ## WooMinecraft
 
@@ -30,14 +85,12 @@ The WooMinecraft supervisor type makes delayed checks to get what order commands
 The store plugin setup is the same as [WooMinecraft wiki](https://github.com/WooMinecraft/WooMinecraft/wiki/Step-2:-Setting-up-the-wordpress-side) and also [the commands](https://github.com/WooMinecraft/WooMinecraft/wiki/Step-3:-Creating-A-Package).
 
 ```yaml
-Check-Interval: 7
-URL: 'http://shop.mysite.com'
+Check-Interval: 600
 Key: 'asdUniqueKeyForServer'
 ```
 
-* `Check-Interval` - Is the interval in seconds to check WooMinecraft rest api from store url.
-* `URL` - Is the store url.
-* `Key` - Is the server key from [WooMinecraft configuration](https://github.com/WooMinecraft/WooMinecraft/wiki/Step-2:-Setting-up-the-wordpress-side).
+* `check-interval` - Is the interval in seconds to check WooMinecraft rest api from store url.
+* `key` - Is the server key from [WooMinecraft configuration](https://github.com/WooMinecraft/WooMinecraft/wiki/Step-2:-Setting-up-the-wordpress-side).
 
 ### WooCommerce integration
 
@@ -62,8 +115,15 @@ Next you only need to set the generated key and secret into web supervisor confi
 
 ```yaml
 WooCommerce:
+  Version: 3
+  Auth: PARAMS
   ConsumerKey: 'ck_theGeneratedConsumerKey'
   ConsumerSecret: 'cs_theGeneratedConsumerSecret'
 ```
 
+* `version` - WooCommerce API version, currently only version 3 is supported.
+* `auth` - The [authentication type](https://woocommerce.github.io/woocommerce-rest-api-docs/#authentication-over-https) to connect with WooCommerce API (`PARAMS` or `BASIC`).
+* `consumerkey` - The generated key.
+* `consumersecret` - The generated secret.
+
 Take in count that every consumer key starts with `ck_` and every consumer secret starts with `cs_`.

docs/es/developers/schema.md

@@ -0,0 +1,86 @@
+---
+sidebar_position: 2
+title: Schema
+description: Esquema de datos para hacer un sitio web compatible con PixelBuy.
+---
+
+Para permitir que la gente haga su propio sitio web conectado con PixelBuy, se ha creado un formato en común.
+
+## REST API
+
+Hacer que tu sitio web transfiera datos con el proceso tipico de `GET` y `POST`.
+
+Se usará contenido en Json para explicar el formato.
+
+### Autenticación
+
+Todos los sitios web compatibles con PixelBuy deben proveer una "clave secreta", la cual será usada por el usuario para obtener información de la API del sitio web.
+
+PixelBuy es compatible con multiples formatos de autenticación:
+
+* Query parameters, al proveer la clave secrete como un query parameter en el mismo URL.
+* Header property, al proveer la clave secrete como un header de http en cada conexión.
+* Basic authentication, al pasar la clave secreta en un header de Basic authentication header en cada conexión.
+
+### Versión 1
+
+**error:** Es la respuesta para comunicar un error.
+
+```json5
+{
+  "error": "error_message_code",
+  "message": "An error has occur",
+  "status": 404,
+}
+```
+
+**(GET) order:** Una orden de compra, el jugador puede ser solo un nombre si no quieres dar el UUID.
+
+```json5
+{
+  "id": 1234, // ID numérico de la orden / número de transacción
+  "date": "1970-01-25", // En formato ISO-8601
+  "player": "7ca003dc-175f-4f1f-b490-5651045311ad:Rubenicos", // [<uuid>:]<nombre>
+  "execution": "BUY", // Opcional, el valor debe ser BUY, RECOVER o REFUND
+  // Puede no haber items si el valor de la ejecución es RECOVER o REFUND
+  "items": [
+    {
+      "product": 55, // Opcional, es el identificador del producto, puede ser cualquier tipo de objeto
+      "id": "super-pickaxe", // El identificador del item que fue configurado en PixelBuy
+      "amount": 1, // La cantidad de items de este tipo, debe ser un número entero
+      "price": 2.49, // La cantidad real de dinero gastado en este items (considera la cantidad de items)
+    },
+    {
+      "product": 94,
+      "id": "eco-bundle",
+      "amount": 6,
+      "price": 5.04,
+    }
+  ]
+}
+```
+
+**(GET) server:** Información sobre el servidor.
+
+```json5
+{
+  // Ordenes de compra que deberían ser procesadas por PixelBuy
+  "pending_orders": [
+    {
+      // Objeto de una orden (arriba está especificado su formato)...
+    },
+    {
+      // Otro objeto de una orden (arriba está especificado su formato)...
+    }
+  ],
+  "next_check": 60, // Opcional, the amount of seconds to wait until make the next check
+}
+```
+
+**(POST) update:** Le dice a la tienda que debe ejecutarse una actualización.
+
+```json5
+{
+  "processed_orders": [ 1234, 6727, 1897 ], // Los IDs de las ordenes que compra que ya fueron procesadas (y por lo tanto ya no deberían aparecer en la información del servidor)
+}
+```