El SDK de Outbarriers se comunica con el backend de Outbarriers mediante un API REST JSON.
En la mayoria de las ocasiones el acceso a la API se hace de forma transparente a través del SDK salvo un caso muy importante.
Como sabes, el SDK de Outbarriers no sólo te ofrece información de manera automática cuando alguien usa tu app cerca de un comercio con balizas Outbarriers, sino que además te garantiza que dicho check-in es real y no simulado/pirateado como sufren muchas apps de geolocalización.
La API utiliza OAuth2 como mecanismo de autenticación y autorización. Para poder usar la API necesitas obtener el access_token
a partir de tu API Key
y tu API Secret
.
En el siguiente ejemplo vemos cómo podemos obtener el access_token
mediante cURL.
curl -X POST -d "grant_type=client_credentials&client_id=API_KEY&client_secret=API_SECRET"
Si los credenciales son correctos, devolverá un objeto JSON con el access_token
{"access_token": "ACCESS_TOKEN", "token_type": "Bearer", "expires_in": 15552000, "scope": "read write"}
Con el access_token
y código UUID
del match podemos realizar la verificación.
curl -X POST -H "Content-type: application/json" -H "Authorization: Bearer ACCESS_TOKEN" -d '{"match": "UUID"}' https://outbarriers.com/api/v1/verify-match/
Si el match es correcto, delvolverá 200 Ok
con un objeto JSON donde se indica el timestamp
(UNIX Time) de cuando se realizó y el tiempo en segundos transcurridos, seconds_away
.
{"status":true,"timestamp":1474378031,"seconds_away":2,"uuid":"UUID"}
Si por el contrario, el match no existe, devolverá 404 Not found
.
{"status":false}