Erreurs
L'API renvoie les codes d'état de réussite ou d'erreur HTTP standard pour toutes les opérations. Pour les erreurs, la réponse comprendra le code d'erreur correspondant, un court message décrivant la cause de l'erreur et éventuellement des champs supplémentaires transmettant des informations spécifiques à cette erreur.
Codes d'état
| 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. |
Codes d'erreur
invalid-body
L'API n'a pas pu traiter le corps de votre demande. Assurez-vous que le corps de la demande est un JSON valide.
invalid-parameter
Un ou plusieurs paramètres de votre requête n'ont pas passé les contrôles de validation. Cette réponse comprendra un attribut params avec plus de détails sur les paramètres incriminés.
unconfigured
Votre organisation ne dispose pas de la configuration requise pour que l'API puisse traiter cette demande. Le message inclura des détails sur la configuration manquante.
missing-scope
Votre organisation, votre clé ou l'utilisateur actuel ne dispose pas des étendues d'autorisation requises pour exécuter cette demande.
limit-exceeded
La demande n'a pas pu être traitée car elle violerait une limite imposée à votre organisation, à votre clé ou à votre utilisateur actuel. Par exemple, un utilisateur limité à deux comptes iCloud par mois recevra cette erreur s'il tente d'accéder à un troisième compte.
session-expired
La session que vous essayez d'utiliser pour cette demande a été marquée comme expirée par l'API. Vous devez créer une nouvelle session valide avant de continuer.
invalid-credentials
Les informations d'identification fournies ont été rejetées par le service externe. Soit la source n’existe pas (c’est-à-dire un nom d’utilisateur non valide), soit le contenu des informations d’identité est incorrect (par exemple, un mot de passe erroné).
source-locked
La source a été verrouillée par le service externe et l'API ne peut y accéder que lorsqu'elle est déverrouillée par l'utilisateur. Le message de l'API fournira des instructions sur la procédure à suivre pour le service concerné.
code-required
La source sur laquelle vous essayez de créer une session est activée par l’authentification multi-facteurs (MFA). L'API aura déclenché le processus MFA et vous devez fournir le code présenté lors de ce processus lors de votre prochaine tentative de création de session.
Pour plus de détails sur le flux de création de session, voir la référence de service pour le service auquel vous essayez d'accéder.
code-rate-limited
L'utilisateur a tenté de créer une session en utilisant un code invalide trop souvent et a été limité par le service. Nous recommandons à l'utilisateur d'attendre au moins une heure avant de réessayer.
choice-required
La vérification à deux étapes (2SV) est activée, un sous-ensemble de l'authentification multi-facteurs (MFA). Dans le cadre de cette réponse, l’API fournira une liste de périphériques contre lesquels le processus 2SV peut être déclenché; cet appareil recevra le code 2SV qui sera nécessaire pour la prochaine étape du processus.
Pour plus de détails sur le flux de création de session, voir la référence de service pour le service auquel vous essayez d'accéder.
task-error
Une erreur de tâche générique s'est produite. Une nouvelle tentative de sondage ou de tâche peut résoudre le problème. Veuillez contacter le support si le problème persiste.
Codes d'erreur du service iCloud
icloud-terms-not-accepted
L'utilisateur n'a pas accepté les dernières conditions d'utilisation d'iCloud. Ils peuvent accepter les conditions en se connectant à l'App Store sur un appareil iOS ou macOS en utilisant leur compte, ou en allant sur iCloud.com .
icloud-account-not-verified
L'adresse e-mail principale associée au compte iCloud n'a pas encore été vérifiée. L'utilisateur doit terminer le processus de vérification des e-mails pour activer le compte. Le processus de vérification peut être géré en vous connectant à appleid.apple.com .
icloud-service-not-activated
Le service iCloud nécessaire pour terminer l'opération n'a pas été activé sur le compte iCloud utilisé. Par exemple, si l'utilisateur n'a pas activé la bibliothèque de photos iCloud sur le compte, cette erreur sera icpl.photos lors de la tentative de récupération d' icpl.photos .
Assurez-vous que l'utilisateur a basculé sur les paramètres associés à un service pour s'assurer qu'il est activé.
icloud-service-outage
L'opération n'a pas pu être terminée en raison d'une panne iCloud. Ce sont très rares et généralement transitoires - une nouvelle tentative en quelques minutes devrait réussir. Cependant, si le problème persiste, recherchez plus d'informations sur la page d'état iCloud et la page d'état API et contactez l'assistance.
