¿Cómo utilizar la API de Oceges?

La API de Oceges te permite obtener información de forma estructurada y sencilla para realizar integraciones personalizadas con tus propias aplicaciones. En este artículo, te explicaremos cómo conectarte para hacer tus primeras llamadas y conseguir una integración total.

Autenticación

Las llamadas a la API requieren un token de autenticación. Para la obtención de este token, debes ponerte en contacto con nosotros a través del email: soporte@oceges.com.

El token debe ser informado en el Header de la petición, bajo la clave OCEGES-TOKEN.

Endpoints

Todas las llamadas se realizan a la URL https://{prefijo_oceges}.oceges.com/api/oceges/ bajo el protocolo HTTPS mediante el método POST.

Para consultar el endpoint específico de cada llamada, accede a la sección correspondiente de la documentación.

Límite de peticiones

Por razones de seguridad, la API de Oceges tiene una limitación global de 300 peticiones por minuto. En caso de superar este límite, se limitará la conexión durante 1 minuto hasta resetear el contador de peticiones.

Parámetros de entrada

La entrada de todas las llamadas será siempre en formato multipart/form-data. En dicha entrada se deben incluir los parámetros requeridos en cada llamada especificados en la documentación. Por ejemplo:

Respuesta

La información devuelta por la API siempre será en formato JSON.

Ejemplo de error:

{
    "status": false,
    "code": 400,
    "error": "The reference type indicated is not valid"
}

Ejemplo de éxito:

{
    "status": true,
    "code": 200,
    "results": [{
        "delivery_id": "110975",
        "sale_id": "140738",
        "date": "2022-09-29 07:39:40",
        ...
    }]
}

Configuración de entorno en Postman

Antes de utilizar la API en un entorno de producción, es conveniente testearla a través de una plataforma de testeo de API. Te recomendamos utilizar Postman, pero puedes utilizar cualquier otra. Para configurar Postman, debes hacer lo siguiente:

1. Descarga la aplicación a través de su web oficial
2. Crea un entorno de trabajo desde el menú Workspaces > Create Workspace. Puedes llamarlo, por ejemplo, Oceges API
   
   
   
3. Descarga la colección de llamadas a la API de Oceges desde el siguiente enlace y descomprímelo para acceder al archivo JSON que debes importar. Última actualización de la colección: 13/10/2022
   
   
4. Haz click en el botón Import ubicado en la franja izquierda e importa el archivo descomprimido en el paso anterior, llamado API Oceges.postman_collection.json. Tras esto, tendrás todas las llamadas en el bloque Collections de la franja izquierda
   
   
   
5. Crea un entorno de variables. Para ello, en el menú izquierdo, accede al bloque Environments y haz click en Create Environment. Llámalo Entorno Oceges y añade las dos siguientes variables

6. Por último, en la esquina superior derecha, selecciona el entorno que acabas de crear 

7. El entorno está completamente configurado y listo para funcionar. Para testear una llamada, ve a Collections y accede a la llamada en cuestión. Una vez ubicado, haz click en Body > form-data e indica los valores necesarios para completar los parámetros de dicha llamada. Si todo es correcto, aparecerá la respuesta en la parte inferior de Postman