diff options
| author | Brian Corrigan <bcorrigan78@gmail.com> | 2017-10-04 08:48:13 -0400 |
|---|---|---|
| committer | Brian Corrigan <bcorrigan78@gmail.com> | 2017-10-04 08:48:13 -0400 |
| commit | 1542bd5e0533c535a5b4410ff83f1db8956a5acd (patch) | |
| tree | 0921b175dc5aef422e667125cefe5cf748c788e1 /es/responses.md | |
| download | vainglory-docs-1542bd5e0533c535a5b4410ff83f1db8956a5acd.tar.gz vainglory-docs-1542bd5e0533c535a5b4410ff83f1db8956a5acd.zip | |
Initial commit
Diffstat (limited to 'es/responses.md')
| -rw-r--r-- | es/responses.md | 67 |
1 files changed, 67 insertions, 0 deletions
diff --git a/es/responses.md b/es/responses.md new file mode 100644 index 0000000..73dd3b8 --- /dev/null +++ b/es/responses.md @@ -0,0 +1,67 @@ +# Recibiendo Respuestas + +## Payload + +Todas las respuestas de servidor contienen un objeto raíz JSON. + +~~~.language-json +{ + "data": { + "type": "match", + "id": "skarn", + "attributes": { + // ... this matches attributes + }, + "relationships": { + // ... this matches relationships + } + } +} +~~~ + +~~~.language-json +{ + "data": { + "type": "match", + "id": "1" + } +} +~~~ + +Una respuesta contendrá al menos uno de los siguientes miembros top-level: + + * `data`: los “datos primarios” de la respuesta + * `errors`: una colección de objetos error + +Una respuesta puede contener cualquiera de estos miembros top-level: + + * `links`: un objeto enlace relacionado a los datos primarios. + * `included`: Una colección de objetos recurso que están relacionados a los datos primarios y/o entre sí (“included resources”). + +Si un documento no contiene una llave de datos top-level, el miembro incluido no estará presente tampoco. + +Datos primarios serán uno de los siguientes: + + * Un único [resource object][resource objects], Un único [resource identifier object], o `null` + * Una colección de [resource objects], una colección de [resource identifier objects][resource identifier object],o una colección vacía (`[]`) + +Por ejemplo, los siguientes datos primarios son un único objeto recurso (single resource object): + +Los siguientes datos primarios son un único [resource identifier object] que refiere al mismo recurso: + +Un grupo de recursos lógico siempre será representada como una colección, incluso si solo contiene un item o si está vacío. + +## Límites De Ratio +>Las cabeceras de límite de ratio son definidas de la siguiente manera: + +~~~ +X-RateLimit-Limit - Límite de peticiones por día / minuto +X-RateLimit-Remaining - El número de peticiones que quedan en ese periodo de tiempo +X-RateLimit-Reset - El tiempo que queda antes que se rellene el límite de ratio en época UTC nanosegundos. +* Tokens de límite son incrementalmente llenados por 60(seg)/ límite de ratio. ejemplo: 60(seg)/10(ratio) consigue un token de ratio cada 6 segundos hasta llegar al límite de ratio máximo. +~~~ +Se bueno. Si envías demasiadas peticiones demasiado rápido, enviaremos un código de error `429` (servidor no disponible). + +<aside class="notice"> +Gratis para uso no comercial para un máximo de 10 peticiones por minuto! Para incrementar tu límite, por favor contacta api@superevilmegacorp.com +</aside>
\ No newline at end of file |
