Inicio
Bienvenido a la documentación de D’Anchiano.
La API de D’Anchiano está organizado alrededor de REST.
Nuestra API tiene URL predecibles orientadas a recursos. Acepta cuerpos de solicitud form-encoded y json-encoded, devuelve respuestas codificadas en JSON y utiliza verbos, autenticación y códigos de respuesta HTTP estándar.
Puedes usar la API de D’Anchiano en modo de prueba, lo que no afecta tus datos en vivo. La clave de API que usas para autenticar la solicitud determina si la solicitud está en modo en vivo o en modo de prueba.
Inicia sesión para ver documentos personalizados para tu versión de la API, con tu clave de prueba y tus datos.
Autenticación
La API de D’Anchiano utiliza claves de API para autenticar solicitudes. Puedes ver y administrar tus claves de API en el panel de administración de la API.
Las claves secretas del modo de prueba tienen el prefijo dk_test_ y las claves secretas del modo en vivo tienen el prefijo dk_live_.
Tus claves de API tienen muchos privilegios, ¡así que asegúrate de mantenerlas seguras! No compartas tus claves secretas de API en áreas de acceso público como GitHub, código del lado del cliente, etc.
La autenticación a la API se realiza a través de HTTP Basic Auth. Proporciona tu clave de API como valor de nombre de usuario de autenticación básico. No es necesario que proporciones una contraseña.
Si necesitas autenticarte a través de la autenticación de portador (por ejemplo, para una solicitud de origen cruzado), usa -H "Authorization: Bearer CLIENT_SECRET" en lugar de -u CLIENT_SECRET.
Todas las solicitudes de API deben realizarse a través de HTTPS. Las llamadas realizadas a través de HTTP simplemente fallarán. Las solicitudes de API sin autenticación también fallarán.
Terminal$curl URL_API/api/v1/me \> -u CLIENT_SECRET:
Errores
D’Anchiano utiliza códigos de respuesta HTTP convencionales para indicar el éxito o el fracaso de una solicitud de API. En general, los códigos en el rango 2xx indican éxito. Los códigos en el rango 4xx indican un error que falló dada la información proporcionada (por ejemplo, se omitió un parámetro requerido, falló una carga, etc.). Los códigos en el rango 5xx indican un error con los servidores de D’Anchiano (estos son raros).
Algunos errores 4xx que podrían manejarse mediante programación incluyen un código de error que explica brevemente el error informado.
| Códigos HTTP | Descripción |
|---|---|
| 200 - OK | Todo funcionó como se esperaba. |
| 400 - Bad Request | La solicitud era inaceptable, a menudo debido a que faltaba un parámetro obligatorio. |
| 401 - Unauthorized | No se proporcionó una clave API válida. |
| 402 - Request Failed | Los parámetros eran válidos pero la solicitud falló. |
| 403 - Forbidden | La clave API no tiene permisos para realizar la solicitud. |
| 404 - Not Found | El recurso solicitado no existe. |
| 409 - Conflict | La solicitud entra en conflicto con otra solicitud (quizás debido al uso de la misma clave idempotente). |
| 429 - Too Many Requests | Demasiadas solicitudes llegan a la API demasiado rápido. Recomendamos una retirada exponencial de tus solicitudes. |
| 500, 502, 503, 504 - Errores del servidor | Algo salió mal al final de D’Anchiano. (Estos son raros). |