API

Para utilizar el API es necesario tener dos token de acceso uno que idetifica al usuario que esta creando la misión y otro que sirve como un mecanismo de seguridad para acceder al API.

El token de usaurio se puede optener al dar click en el icono ubicado en la parte superior derecha y luego escoger la opción "Ver mi token".

El token para acceder el API también es llamado "Llave de acceso" y puede obtenerse haciendo click en el icono de llave que aparece en la barra de navegación. Al ingresar por seguridad se le pedira su clave. Luego de click en el boton "Nueva Llave" que esta en la parte superior derecha. Las llaves de acceso deben ser tratadas con confidencialidad por lo que de nuevo se le pedira ingresar su clave. Luego se muestra una pequeña ventana donde podrá dar un nombre a la llave y una descripción.

Luego se mostrara la llave de acceso para el API que será necesario utilizar en las consultas que a continuación se explicaran. Recuerda esta clave debe ser compartida y utilizada solo por tu programador.

El API es lo que formalmente se conoce como "REST API" y utiliza los siguientes metodos: GET, POST, PATCH y se comunica con el esquema JSON (javascript object notation). Actualmente solo permitimos ver, crear y actualizar misiones.

El dominio y los headers para comunicarse con el API son:

HOST: https://api.optacheck.com
PUERTO: 443
Headers: Authorization write-here-the-api-key

Las principales URL son:

/v1.0/workspaces/<workspace-id>/assignments/

/v1.0/workspaces/<workspace-id>/assignments/<mission-id>/

Un ejemplo de como luce un JSON de una mision:

{
  "id": "afc76c05-136e-4fda-8286-33a3c55a4008",
  "shortid": "c8704868",
  "status": "done",
  "status_name": "completada",
  "title": "Mi misión de GPS",
  "description": "GPS prueba",
  "form": "319b2948-13e9-43d0-b476-2e4b19429433",
  "form_name": "Simple Test A",
  "user": "8d193a8d-374d-427b-a185-858141f4163e",
  "project": "d132da95-1f8a-46f5-aba1-242a11fbc54e",
  "project_name": "Asesoría",
  "client": "0170de59-c3e4-41b7-8b7f-3eae07caf66b",
  "client_name": "Tiendas B",
  "data": {
      "fields": [
          {
              "title": "Tu nombre",
              "value": "Gggg",
              "editable": true,
              "type": "text",
              "max_length": 100
          },
          {
              "localSrc": "file:///storage/emulated/0/Android/data/com.optagonal.optacheck/cache/1531814803957.jpg",
              "title": "Foto de tu computadora",
              "value": "7b4ad6af-342d-4445-9eef-fa45431e06c8",
              "remoteUrl": "ws/53eb4a82-0cef-4d3f-82d9-dadb4b687c32/assignment/afc76c05-136e-4fda-8286-33a3c55a4008/photo/7b4ad6af-342d-4445-9eef-fa45431e06c8.jpeg",
              "type": "photo"
          },
          {
              "title": "Tu ubicación",
              "value": {
                  "lng": -90.4816147,
                  "lat": 14.5271295,
                  "accuracy": 28.34
              },
              "type": "gps"
          },
          {
              "title": "Cuando te la dieron?",
              "value": "2015-11-21",
              "type": "date"
          },
          {
              "title": "Marca",
              "value": 3,
              "select_default_value": "",
              "select_values": [
                  {
                      "value": "HP",
                      "idx": 1
                  },
                  {
                      "value": "DELL",
                      "idx": 2
                  },
                  {
                      "value": "Apple",
                      "idx": 3
                  }
              ],
              "type": "select"
          },
          {
              "title": "Esta funcionando bien?",
              "value": true,
              "type": "checkbox"
          },
          {
              "title": "Si esta funcionando mal. Cual es el problema?",
              "value": "Fhvvvb",
              "editable": true,
              "type": "text",
              "max_length": "500"
          }
      ]
  },
  "by_user": "4b3e1a3d-4719-4bea-bf2c-af94af3645dc",
  "date_edited": "2018-07-17T08:07:06.860791Z",
  "date_created": "2018-07-17T08:06:09.860412Z",
  "sync": true,
  "date_due": null,
  "user_data": {
      "id": "8d193a8d-374d-427b-a185-858141f4163e",
      "shortid": "5ad66cad",
      "email": "dev.somosgps@gmail.com",
      "name": "Dev",
      "last_name": "Gps"
  },
  "by_user_data": {
      "id": "4b3e1a3d-4719-4bea-bf2c-af94af3645dc",
      "shortid": "b5ed7ec2",
      "email": "jspblm@gmail.com",
      "name": "Jose",
      "last_name": "Montúfar"
  }
}