API REST

Obtén las configuraciones de la aplicación

Request

GET /:site_id/@@rapido/:app_id
Accept: application/json

Response

{"no_settings": {}}

Cabecera Response HTTP

x-csrf-token: token

Devuelve la configuración de la aplicación Rapido y establece un token en el valor del encabezado HTTP X-CSRF-TOKEN.

Esta cabecera HTTP tendrá que ser reutilizada en todas las solicitudes hechas a la API (excepto para las solicitudes GET).

Autenticación

Algunas de las operaciones siguientes requieren autenticación antes de que se ejecuten correctamente. Tendrá que generar una cadena de autorización (una versión codificada Base64 de su nombre de usuario y contraseña separados por un punto).

Cadena Básica de Autenticación

Si su nombre de usuario es «john» y su contraseña es «password», puede generar rápidamente la cadena de autorización básica en el indicador python de la siguiente manera:

>>> "john.password".encode('base64','strict').strip()
'am9obi5wYXNzd29yZA=='

Ahora usted usa esta cabecera en todos sus requests:

Authorization: Basic am9obi5wYXNzd29yZA==

Nota

El X-CSRF-TOKEN esperado cambiará cuando utilice un encabezado de autorización básica.

Calcular un elemento

Request

GET /:site_id/@@rapido/:app_id/blocks/:block_id/:element_id
Accept: application/json
X-CSRF-TOKEN: :token

o:

POST /:site_id/@@rapido/:app_id/blocks/:block_id/:element_id
Accept: application/json
X-CSRF-TOKEN: :token

Response

{"something": "bla"}

Devuelve el valor devuelto por el cálculo del elemento. El X-CSRF-TOKEN no es necesario para un GET si el cálculo no produce ningún cambio.

Obtener un registro

Request

GET /:site_id/@@rapido/:app_id/record/:record_id
Accept: application/json
X-CSRF-TOKEN: :token

Response

{"item1": "value1", "id": "boom"}

Devuelve los elementos registro.

Obtiene todos los registros

Request

GET /:site_id/@@rapido/:app_id/records
Accept: application/json
X-CSRF-TOKEN: :token

Response

[{"path": "http://localhost:8080/demo/@@rapido/test2/record/boom", "id": "boom", "items": {"bla": "bla", "id": "boom"}},
 {"path": "http://localhost:8080/demo/@@rapido/test2/record/10025657", "id": "10025657", "items": {"id": "10025657"}},
 {"path": "http://localhost:8080/demo/@@rapido/test2/record/9755269", "id": "9755269", "items": {"bla": "bli", "id": "9755269"}},
 {"path": "http://localhost:8080/demo/@@rapido/test2/record/8742197835653", "id": "8742197835653", "items": {"bla": "bli", "id": "8742197835653"}},
 {"path": "http://localhost:8080/demo/@@rapido/test2/record/9755345", "id": "9755345", "items": {"id": "9755345"}}]

Devuelve todos los registros.

Crear un nuevo registro

Request

POST /:site_id/@@rapido/:app_id
Accept: application/json
X-CSRF-TOKEN: :token
{"item1": "value1"}

Response

{"path": "http://localhost:8080/demo/@@rapido/test2/record/9755269", "id": "9755269", "success": "created"}

Crear un nuevo registro con los elementos proveídos.

Crear muchos registros

Request

POST /:site_id/@@rapido/:app_id/records
Accept: application/json
X-CSRF-TOKEN: :token
[{"item1": "a"}, {"item1": "b", "item2": "c"}]

Response

{"total": 2, "success": "created"}

Creación masiva de registros.

Crear un nuevo registro por id

Request

PUT /:site_id/@@rapido/:app_id/record/:record_id
Accept: application/json
X-CSRF-TOKEN: :token
{"item1": "value1"}

Response

{"path": "http://localhost:8080/demo/@@rapido/test2/record/boom", "id": "boom", "success": "created"}

Crear un nuevo registro con los elementos proveídos y teniendo el id especifico.

Elimina un registro

Request

DELETE /:site_id/@@rapido/:app_id/record/:record_id
Accept: application/json
X-CSRF-TOKEN: :token

Response

{"success": "deleted"}

Elimina el registro.

Remueve todos los registros

Request

DELETE /:site_id/@@rapido/:app_id/records
Accept: application/json
X-CSRF-TOKEN: :token

Response

{"success": "deleted"}

Remueve todos los registros y elimina los índices.

Actualiza un registro

Request

POST /:site_id/@@rapido/:app_id/record/:record_id
Accept: application/json
X-CSRF-TOKEN: :token
{"item1": "newvalue1"}

o:

PATCH /:site_id/@@rapido/:app_id/record/:record_id
Accept: application/json
X-CSRF-TOKEN: :token
{"item1": "newvalue1"}

Response

{"success": "updated"}

Actualiza el registro con los elementos proveídos.

Búsqueda de registros

Request

POST /:site_id/@@rapido/:app_id/search
Accept: application/json
X-CSRF-TOKEN: :token
{"query": "total>0", "sort_index": "total"}

Response

[{"path": "http://localhost:8080/tutorial/@@rapido/rating/record//tutorial/news", "id": "/tutorial/news", "items": {"total": 5, "id": "/tutorial/news"}},
 {"path": "http://localhost:8080/tutorial/@@rapido/rating/record//tutorial", "id": "/tutorial", "items": {"total": 8, "id": "/tutorial"}}]

Búsqueda de registros.

Reíndice

Request

POST /:site_id/@@rapido/:app_id/refresh
Accept: application/json
X-CSRF-TOKEN: :token

Response

{"success": "refresh", "indexes": ["id", "total"]}

Vuelve a declarar los índices y vuelve a indexar todos los registros.