Sua empresa está habilitada?

Esta é a primeira página a consultar quando uma chamada responde 403. Se você ainda não fez a primeira chamada, comece por Faça a primeira requisição.

A API pública nasce desabilitada

Toda empresa nasce com a API pública desabilitada. Habilitá-la é uma contratação, feita pela MSP Works: peça pelo suporte, que também atende o pedido de concessão de escopos.

Enquanto a API estiver desabilitada e a empresa não tiver escopos liberados por concessão, toda requisição responde 403 public_api_disabled, mesmo com uma chave válida. Com uma concessão, só os escopos liberados funcionam; os demais respondem 403 scope_requires_public_api:

{
  "code": "public_api_disabled",
  "detail": "A API pública não está habilitada para esta empresa. Fale com a MSP Works para habilitá-la. As chaves de API existentes continuam guardadas e voltam a funcionar quando ela for habilitada.",
  "requestId": "7f3c2a9e-1b4d-4c8e-9a51-2e6f0d8b3c47",
  "status": 403,
  "title": "API pública desabilitada",
  "type": "https://developers.mspdesk.com.br/erros/#public_api_disabled"
}

As chaves já criadas continuam guardadas e voltam a funcionar assim que a API é habilitada.

Concessão de escopos

A MSP Works pode liberar à empresa, por concessão, escopos de leitura que funcionam mesmo com a API desabilitada. São os “escopos liberados por concessão”. Com a API desabilitada, só esses escopos funcionam; os demais respondem 403 scope_requires_public_api:

{
  "code": "scope_requires_public_api",
  "detail": "A API pública não está habilitada para esta empresa, e este escopo não está entre os liberados por concessão. Marcar o escopo na chave não resolve: fale com a MSP Works para contratar a API pública.",
  "requestId": "7f3c2a9e-1b4d-4c8e-9a51-2e6f0d8b3c47",
  "requiredScope": "tickets:write",
  "status": 403,
  "title": "Escopo não liberado sem a API pública",
  "type": "https://developers.mspdesk.com.br/erros/#scope_requires_public_api"
}

Esse erro não se resolve na chave: o escopo precisa estar entre os concedidos à empresa, ou a API precisa estar habilitada. Enquanto a API estiver desabilitada, o MSP Desk nem deixa criar ou editar uma chave com um escopo fora da concessão.

Recebi X, faço Y

Resposta	Significa	O que fazer
`401 invalid_api_key` / `api_key_expired` / `api_key_revoked` / `api_key_inactive`	problema na chave	ver Chaves de API
`403 account_inactive`	empresa inativa no MSP Desk	falar com o suporte
`403 public_api_disabled`	API não habilitada, nenhum escopo concedido	falar com o suporte
`403 scope_requires_public_api`	o escopo não está entre os concedidos	mexer na chave não resolve; falar com o suporte
`403 insufficient_scope`	a chave não tem o escopo (`requiredScope` no corpo)	editar a chave e adicionar o escopo

Qual erro vem primeiro

Empresa inativa vence tudo: account_inactive responde antes de qualquer outro 403, mesmo que a API esteja habilitada e a chave tenha o escopo.