Esta información es común a todas nuestras APIs, así que te recomendamos leerla con atención.
Autenticación
Para utilizar nuestra API, necesitas un token de autenticación que puedes solicitar a nuestro equipo escribiendo a api@biglelegal.com.
Cada token tendrá acceso a las APIs que solicites y solo a esas. Recomendamos encarecidamente tener un token independiente para cada API, pero entendemos que puede ser útil tener diferentes combinaciones.
Cada llamada a nuestras APIs debe llevar este token en los encabezados de la solicitud para garantizar que vosotros y únicamente vosotros podéis acceder a vuestros datos. Cualquier solicitud realizada sin autenticación fallará.
Protocolo
Todas las solicitudes de API deben realizarse a través de HTTPS. Las llamadas realizadas a través de HTTP simple fallarán.
Carga útil
Usamos solicitudes y respuestas codificadas en JSON.
Peticiones
Cada end-point de la API tiene su propio conjunto de parámetros. Están divididos en:
-
- Parámetros de solicitud: estos parámetros forman parte de la URL y se utilizan para identificar el recurso que nos interesa. Por ejemplo, si queremos obtener la estructura de una plantilla determinada, tendremos que proporcionar el identificador único de la plantilla en la URL.
- Parámetros de consulta: estos parámetros se adjuntan a la solicitud y se utilizan para modificar la respuesta que obtenemos cuando solicitamos los recursos que nos interesan.
- Cuerpo de la solicitud: estos parámetros se especifican en el cuerpo de la solicitud y se utilizan para crear o modificar el recurso que nos interesa. Por ejemplo, si queremos crear un nuevo documento, también tendremos que proporcionar el nombre y el contenido del documento.
Respuesta
Dividiremos nuestros casos de respuesta en dos:
-
- Éxito: todo funciona como se esperaba. Dependiendo del punto final que usemos, podríamos recibir una respuesta vacía, por ejemplo, si eliminamos un documento, o un conjunto de parámetros resultado de la operación que solicitamos, como el identificador único del documento cuando creamos un documento.
- Error: algo no funcionó como se esperaba. Recibiremos un mensaje explicando qué salió mal. También obtendremos una fecha y un id de petición que será útil si necesitamos más detalles.
Estado
Todas nuestras API tienen un punto final de estado para comprobar si el servicio correspondiente está disponible. Siempre devolverá un estado HTTP 200, así como la versión de API.
Podemos comprobar el estado general de las API en nuestro panel de estado.