Erros
A API retorna códigos de status de sucesso ou erro HTTP padrão para todas as operações. Para erros, a resposta incluirá o código de erro correspondente, uma mensagem curta descrevendo a causa do erro e, opcionalmente, campos adicionais transmitindo informações específicas para esse erro.
Códigos de status
| code | name | description |
|---|---|---|
| 200 | OK | The request was processed succesfully. |
| 201 | Created | The request was processed successfully, and a new resource instance was created. |
| 400 | Bad Request | The API was unable to process the request as it was malformed in some way. |
| 401 | Unauthorized | The API was unable to find valid credentials in the request. |
| 403 | Forbidden | The credentials provided do not have sufficient permissions to perform the request. |
| 404 | Not Found | The requested resources cannot be found. |
| 429 | Too Many Requests | The request has not been processed as a rate limit has been reached. |
| 5xx | Internal Server Error | An unexpected error occurred while processing the event. |
Códigos de erro
invalid-body
A API não conseguiu processar o corpo da sua solicitação. Certifique-se de que o corpo da solicitação seja um JSON válido.
invalid-parameter
Um ou mais parâmetros no corpo da sua solicitação não passaram nas verificações de validação. Essa resposta incluirá um atributo params com mais detalhes sobre parâmetros problemáticos.
unconfigured
Sua organização não tem a configuração necessária para que a API conclua essa solicitação. A mensagem incluirá detalhes sobre qual configuração está faltando.
missing-scope
Sua organização, chave ou usuário atual não possui os escopos de permissão necessários para executar essa solicitação.
limit-exceeded
A solicitação não pôde ser concluída, pois violaria um limite imposto à sua organização, chave ou usuário atual. Por exemplo, um usuário limitado a acessar duas contas do iCloud por mês receberá esse erro se tentar acessar uma terceira conta.
session-expired
A sessão que você está tentando usar para essa solicitação foi marcada como expirada pela API. Você deve criar uma nova sessão válida antes de continuar.
invalid-credentials
As credenciais fornecidas foram rejeitadas pelo serviço externo. A origem não existe (ou seja, nome de usuário inválido) ou a carga útil das credenciais está incorreta (como uma senha incorreta).
source-locked
A origem foi bloqueada pelo serviço externo e não pode ser acessada pela API até ser desbloqueada pelo usuário. A mensagem da API fornecerá instruções sobre como fazer isso para o serviço relevante.
code-required
A origem na qual você está tentando criar uma sessão tem a ativação de vários fatores (MFA) ativada. A API acionou o processo do MFA e você deve fornecer o código apresentado durante esse processo na sua próxima tentativa de criação de sessão.
Para obter mais detalhes sobre o fluxo de criação de sessão, consulte a referência de serviço para o serviço que você está tentando acessar.
code-rate-limited
O usuário tentou criar uma sessão usando um código inválido com frequência e foi limitado pela taxa pelo serviço. Recomendamos que o usuário aguarde pelo menos uma hora antes de tentar novamente.
choice-required
A origem que você está tentando acessar tem a verificação em duas etapas (2SV) ativada, um subconjunto da autenticação multifator (MFA). Como parte dessa resposta, a API fornecerá uma lista de dispositivos que podem acionar o processo 2SV; este dispositivo receberá o código 2SV que será necessário para a próxima etapa do processo.
Para obter mais detalhes sobre o fluxo de criação de sessão, consulte a referência de serviço para o serviço que você está tentando acessar.
task-error
Ocorreu um erro de tarefa genérica. Repetir a pesquisa ou tarefa pode resolver o problema. Entre em contato com o suporte se o problema persistir.
Códigos de erro do serviço iCloud
icloud-terms-not-accepted
O usuário não aceitou os mais recentes Termos de Serviço do iCloud. Eles podem aceitar os termos entrando na App Store em um dispositivo iOS ou macOS usando sua conta ou acessando o iCloud.com .
icloud-account-not-verified
O endereço de email principal associado à conta do iCloud ainda não foi verificado. O usuário deve concluir o processo de verificação de email para ativar a conta. O processo de verificação pode ser gerenciado fazendo login em appleid.apple.com .
icloud-service-not-activated
O serviço iCloud necessário para concluir a operação não foi ativado na conta do iCloud em uso. Por exemplo, se o usuário não tiver ativado a Biblioteca de Fotos do iCloud na conta, esse erro será gerado ao tentar recuperar o icpl.photos .
Verifique se o usuário alternou nas configurações associadas de um serviço para garantir que ele esteja ativado.
icloud-service-outage
A operação não pôde ser concluída devido a uma interrupção do iCloud. Estes são muito raros e, geralmente, transitórios - a tentativa dentro de alguns minutos deve ser bem-sucedida. No entanto, se o problema persistir, procure mais informações na página de status do iCloud e na página de status da API e entre em contato com o suporte.
