Tiendy Documentación
API

Autenticación con OAuth

Tiendy usa OAuth para autorizar el acceso de tu aplicación a la API. El flujo tiene tres pasos: autorizar, obtener el token y usarlo en cada llamada.

Dónde se hace. Los tres pasos ocurren en el dominio de la tienda, https://STORE_NAME.mitiendy.com. Sustituye STORE_NAME por el identificador de la tienda con la que trabaja tu aplicación.

1. Iniciar la autenticación

Redirige al propietario de la tienda a la siguiente URL para que conceda los permisos de tu aplicación:

GET https://STORE_NAME.mitiendy.com/admin/auth/authorize

Muestra el formulario de confirmación de permisos y redirige de vuelta a tu aplicación con un código temporal.

Parámetros de la llamada:

ParámetroDescripción
client_idLa clave API de tu aplicación.
scopeLa lista de permisos que necesita tu aplicación.
redirect_uriOpcional. URL a la que se redirige al usuario tras confirmar. Debe empezar por la URL configurada en los ajustes de tu aplicación.

El propietario verá un formulario de confirmación para conceder los permisos solicitados. Al aceptar, se redirige a la redirect_uri indicada con un código temporal como parámetro GET. Si tu URL de retorno es http://mytiendyapp.com/app, la llamada queda así:

http://mytiendyapp.com/app?code=TEMPORARY_AUTH_CODE

2. Obtener el token de acceso

Para obtener el token permanente realiza una llamada a la siguiente URL:

POST https://STORE_NAME.mitiendy.com/admin/auth/token

Intercambia el código de autorización por el token de acceso.

ParámetroDescripción
client_idLa clave API de tu aplicación.
client_secretLa clave compartida de tu aplicación.
codeEl código de autorización obtenido en el paso anterior.

Ejemplo de llamada:

curl https://STORE_NAME.mitiendy.com/admin/auth/token -d 'code=e200642a3e99fd38735bbf5ee9e062e750117b6e&client_id=testcid&client_secret=testsecret'

La respuesta es un objeto JSON con el token:

{
    "access_token": "fb14a61f52b8cf63f9828c7d8f74d041948c6372",
    "expires_in": 31536000,
    "scope": "read_products"
}

3. Acceder a los recursos

Una vez obtenido el token, úsalo en cada llamada a la API mediante la cabecera X-Tiendy-Access-Token:

X-Tiendy-Access-Token: fb14a61f52b8cf63f9828c7d8f74d041948c6372

También es posible pasar el token como parámetro de la URL (access_token), pero recomendamos usar la cabecera.

Ejemplo:

curl -H "X-Tiendy-Access-Token: 237c445ea655b2f380eac1974a9f36feb1053317" https://STORE_NAME.mitiendy.com/admin/products.json

4. Permisos

Según las necesidades de cada aplicación, es posible obtener permisos para acceder a determinados recursos de la tienda.

PermisoRecurso
(read|write)_productsProduct
(read|write)_ordersOrder

Ejemplo de solicitud con dos permisos:

curl https://STORE_NAME.mitiendy.com/admin/auth/authorize?client_id=API_KEY&scope=write_products%20read_orders

Los permisos de escritura llevan implícitos los de lectura: no hace falta pedir ambos.

Basado en la documentación pública de la API de Tiendy.