Autenticação

1Criar uma chave de API

Para conectar seu aplicativo à loja, você precisa de uma chave de API. No painel administrativo, escolha as permissões para definir quais dados o aplicativo pode ler e o que pode alterar na loja.

Você também pode informar os endereços IP que o aplicativo usará para acessar a API. Se os informar, a chave só poderá ser usada a partir desses endereços. Depois, crie a chave de API.

2Obtenha um token de acesso

Um token de acesso permite enviar solicitações sem incluir a chave de API em cada solicitação. Você pode revogar o token quando não precisar mais dele.

Com o token, você recebe as permissões e os limites de requisições da API da sua loja.

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"
  }
}

3Envie requisições à API

Use o token recebido ao enviar requisições à API. Respeite os limites de requisições da loja. O acesso a cada operação também depende das permissões do seu plano.

Se precisar escolher um idioma ou mercado para suas solicitações, consulte o contexto da loja. Você receberá os idiomas e mercados disponíveis com seus códigos e identificadores.

4Revogue o token

Revogar o token é opcional. Se você o usar para uma tarefa única, recomendamos revogá-lo ao terminar. Sem revogação manual, o token continuará válido até o fim do prazo definido. Depois disso, não poderá mais ser usado.

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"
  }
}