Introducción
La API de Orzame le permite interactuar con la aplicación Orzame a través de una API REST simple.
URI y entornos
La API de Orzame está alojada en la siguiente URI base:
https://api.orzame.comNo hay un entorno de pruebas, pero puedes probarlo con una cuenta básica gratuita. Ten en cuenta las limitaciones del plan gratuito al realizar las pruebas.
Versionado
La versión se añadirá a la url:
https://api.orzame.com/v1Un ejemplo de una url completa de un endpoint, para la versión 1, sería:
https://api.orzame.com/v1/contactsAutenticación
Para utilizar la API, debes autenticar tu solicitud incluyendo tu clave de API como un valor de token en las cabeceras de la solicitud:
Authorization: Bearer API_KEY_HERELa API_KEY se proporciona a través de tu aplicación, por "Empresa", si tienes más de una empresa creada en la aplicación, necesitarás una clave API para cada una. Puedes generar esta API_KEY en la configuración de la empresa, en la sección "Api Access". Solo los propietarios de empresas pueden generar claves de API.
Asegúrate de mantenerlas en secreto. No compartas tus claves API en áreas de acceso público como GitHub, código del lado del cliente, etc.
Formato y encabezados
La Api solo admite el formato json. Asegúrate de tener los siguientes encabezados configurados en cada solicitud:
Accept: application/json
Content-Type: application/jsonLímites de solicitudes
La API tiene un límite de 60 solicitudes por minuto por cuenta de empresa entre todas sus apps o por usuario.
Para facilitar la determinación de si tu aplicación está siendo limitada por exceso de peticiones o aproximándose a ese nivel, agregamos los siguientes encabezados HTTP las respuestas exitosas:
X-RateLimit-Limit
X-RateLimit-RemainingSi tu excedes el límite recibirás un respuesta 429 Too Many Requests. Puedes comprobar, cuantos segundos tienes que esperar parar volver a realizar la petición, con la siguiente cabecera:
Retry-AfterMétodos de peticiones
- Las listas estarán paginadas y contendrán un máximo de 100 resultados.
- Por defecto, si la documentación del endpoint no dice lo contrario, se devolverán las listas ordenadas por identificador de manera decrecientes, el último creado será el primero de la lista.
- Por defecto, si la documentación del endpoint no dice lo contrario, las cadenas tendrán un longitud de 255 caracteres como máximo.
- Para el intercambio de información se usaran variables con formato snake_case.
- Las variables de fecha y hora siempre devolverán cadenas formateadas según el estándar ISO 8601.
Variables y solicitudes
Cada endpoint de recurso puede admitir uno o más de los siguientes métodos HTTP:
- POST para creación de recursos
- GET para leer recursos, tanto individuales como colecciones
- PATCH para actualizaciones parciales de recursos
- PUT para actualizaciones completas de recursos
- DELETE para eliminación de recursos
Errores
Orzame utiliza códigos de respuesta HTTP convencionales para indicar el éxito o el fracaso de una solicitud de API. La siguiente tabla contiene un resumen de los códigos de respuesta típicos:
| Código | Descripción |
|---|---|
| 200 | Todo está bien. |
| 201 | Creado, indica que la solicitud fue exitosa y condujo a la creación de un recurso. |
| 202 | La solicitud ha sido aceptada para su procesamiento, pero el procesamiento no se ha completado. |
| 204 | El servidor cumplió con éxito la solicitud y no hay contenido adicional para enviar en el cuerpo de la respuesta. |
| 400 | Se proporcionaron datos válidos pero la solicitud falló. |
| 401 | Acceso no autorizado. No se proporcionó ninguna clave de API válida. |
| 403 | Acceso prohibido. Existe una clave de API válida pero sin suficientes permisos. |
| 404 | No se pudo encontrar el recurso de solicitud. |
| 409 | La solicitud no se completó por un conflicto con el estado del recurso o una regla de negocio. |
| 422 | A la carga útil le faltan parámetros obligatorios o se proporcionaron datos no válidos. |
| 429 | Demasiados intentos. |
| 500 | La solicitud falló debido a un error interno. |
| 503 | La aplicación está fuera de línea por mantenimiento. |
Pregúntanos
Si necesitas ayuda, envíanos un correo electrónico con información sobre lo que estás haciendo, lo que intentaste y lo que salió mal, también si necesitas hacer algo que aún no es posible hacerlo a través de la API, haremos todo lo posible para ayudarte.