Autenticação

1Criar uma chave de API

Para ligar a sua aplicação à loja, precisa de uma chave de API. No painel de administração, escolha as permissões para definir os dados que a aplicação pode ler e o que pode alterar na loja.

Também pode indicar os endereços IP a partir dos quais a aplicação acederá à API. Se os indicar, a chave só poderá ser utilizada a partir desses endereços. Depois, crie a chave de API.

2Obtém um token de acesso

Um token de acesso permite enviar pedidos sem incluir a chave de API em cada pedido. Pode revogá-lo quando deixar de precisar dele.

Com o token, recebes as permissões e os limites de pedidos da API da tua 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"
  }
}

3Envia pedidos à API

Usa o token recebido ao enviar pedidos à API. Respeita os limites de pedidos da loja. O acesso a cada operação também depende das permissões do teu plano.

Se precisar de escolher um idioma ou mercado para os pedidos, consulte o contexto da loja. Receberá os idiomas e mercados disponíveis com os respetivos códigos e identificadores.

4Revoga o token

Revogar o token é opcional. Se o utilizar para uma tarefa única, recomendamos revogá-lo ao terminar. Sem revogação manual, o token continuará válido até ao fim do prazo definido. Depois disso, deixará de poder ser utilizado.

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