Autenticación

1Crear una clave API

Para conectar tu aplicación con la tienda necesitas una clave API. En el panel de administración, elige sus permisos para indicar qué datos puede leer la aplicación y qué puede modificar en la tienda.

También puedes indicar las direcciones IP desde las que la aplicación accederá a la API. Si las añades, la clave solo podrá utilizarse desde esas direcciones. Después, crea la clave API.

2Obtén un token de acceso

Un token de acceso permite enviar solicitudes sin incluir la clave API en cada solicitud. Puedes revocarlo cuando ya no lo necesites.

Junto con el token recibirás los permisos y los límites de solicitudes API de tu tienda.

curl --disable --globoff --fail-with-body --silent --show-error \
  --proto '=https' --connect-timeout 5 --max-time 30 \
  --request POST \
  --url https://shop.onshopently.com/api/v1/auth/token \
  --header 'Authorization: ApiKey EXAMPLE_API_KEY' \
  --header 'Content-Type: application/json' \
  --data-raw '{"ttl_seconds":1800}'

{
  "data": {
    "access_token": "EXAMPLE_ACCESS_TOKEN",
    "expires_at": "2026-01-01T12:15:00Z",
    "expires_in": 1800,
    "permissions": [
      "orders.order:read"
    ],
    "rate_limits": {
      "auth_per_minute": 1,
      "read_per_minute": 2,
      "write_per_minute": 15
    },
    "token_type": "Bearer",
    "warnings": []
  },
  "meta": {
    "request_id": "example"
  }
}

3Envía solicitudes a la API

Usa el token recibido al enviar solicitudes a la API. Respeta los límites de solicitudes de tu tienda. El acceso a cada operación también depende de los permisos de tu plan.

Si necesitas elegir un idioma o un mercado para tus solicitudes, consulta el contexto de la tienda. Recibirás los idiomas y mercados disponibles con sus códigos e identificadores.

4Revoca el token

Anular el token es opcional. Si lo usas para una tarea puntual, recomendamos anularlo al terminar. Si no lo anulas manualmente, el token seguirá siendo válido hasta que termine su duración. Después ya no podrá utilizarse.

curl --disable --globoff --fail-with-body --silent --show-error \
  --proto '=https' --connect-timeout 5 --max-time 30 \
  --request POST \
  --url https://shop.onshopently.com/api/v1/auth/revoke \
  --header 'Authorization: ApiKey EXAMPLE_API_KEY' \
  --header 'Content-Type: application/json' \
  --data-raw '{"access_token":"EXAMPLE_ACCESS_TOKEN"}'

{
  "data": {
    "revoked": true
  },
  "meta": {
    "request_id": "example-request"
  }
}