Per a desenvolupadors
Errors de l'API
Cada error respon amb JSON i un codi a detail, com ara {"detail": "auth.unauthorized"}. Alguns codis hi afegeixen camps al costat.
| Estat | Codi | Significat | També retorna |
|---|---|---|---|
| 400 | assess.unsupportedLanguage | language (o source_language o target_language) no és cap dels codis d’idioma de l’API, escrit exactament. | — |
| 400 | request.bodyNotJson | El cos JSON no s’ha pogut llegir com a JSON. | — |
| 400 | request.unknownAudioFormat | audio_format no és ni mp3 ni wav. | — |
| 400 | assess.noAudio | El fitxer audio és buit. | — |
| 400 | assessment.audioUnreadable | El fitxer pujat no és un àudio que Spelly pugui llegir. | — |
| 401 | auth.unauthorized | La capçalera X-API-Key falta, és incorrecta o està revocada. | — |
| 401 | widget.keyInvalid | La clau del widget és desconeguda o està revocada. | — |
| 402 | operator.trialExhausted | S’han esgotat les teves unitats. | remaining i requested (unitats), upgrade_url (null mentre no es venguin plans) |
| 403 | auth.endpointNotAllowed | La teva clau no pot cridar aquesta ruta; les que pot cridar són a Tots els endpoints. | — |
| 403 | operator.inactive | El compte al qual pertany la clau està en pausa o eliminat. | — |
| 404 | request.notFound | Aquesta ruta no existeix. | — |
| 405 | request.methodNotAllowed | La ruta existeix, però no amb aquest mètode. | — |
| 413 | assess.recordingTooLong | La gravació supera la mida màxima. | — |
| 413 | request.tooLarge | El cos de la petició és massa gran. | — |
| 422 | assessment.nothingHeard | L'enregistrament no conté veu: és en silenci o el micròfon no ha captat res. No es cobra res. | — |
| 422 | request.invalid | Falta un camp, n’hi ha un que la crida no accepta o té un valor que no accepta; o el cos no és un objecte JSON. | errors: un {"field", "problem"} per cada camp erroni, amb un value en alguns problemes; problem és un tipus com missing, extra_forbidden (un camp que la crida no accepta), string_too_long, no_letters (un text sense lletres per llegir), dict_type (el cos no és un objecte JSON), unknown_sound o literal_error |
| 429 | request.tooManyRequests | Massa peticions: des de la teva adreça (consulta Límits d’ús), o per sobre del límit per minut propi de la teva clau quan en té un. | Capçalera Retry-After: segons que cal esperar |
| 500 | server.failed | Alguna cosa ha fallat a Spelly. | — |
| 503 | service.busy | Spelly està ocupat: hi ha peticions esperant el seu torn. | Capçalera Retry-After: segons que cal esperar |
| 503 | service.unavailable | El servei d’avaluació i veu de Spelly no respon ara mateix. L’estat de Spelly diu si ha caigut. | Capçalera Retry-After: segons que cal esperar |
| 503 | service.maintenance | Spelly s’està actualitzant, normalment durant un o dos minuts. Es rebutja cada crida fins que torna, així que res no queda a mig fer. L’estat de Spelly també ho mostra. | Capçalera Retry-After: segons que cal esperar |