Diferencia entre revisiones de «API Pedido Rastreo»

Revisión del 17:24 25 sep 2023

Descripción: Esta API permite la sincronizacion de sucursales entre SERPI y la plataforma que lo requiera permitiendo tener un manejo estandar entre las dos herramientas.

Autorización: Se requiere autenticación para todas las solicitudes. Las credenciales de autenticación deben ser incluidas en la cabecera de todas las solicitudes a través del campo Authorization utilizando el token de acceso entregado SERPI ERP.

Beneficio:

Tipos de peticiones: GET, POST, PUT

¿Cómo funciona?

Tenga en cuenta que un mismo token no puede ser consumidos de manera simultanea, por lo cual puede programar que la siguiente API sea consumida cuando el resultado de la anterior sea exitoso.
En términos de tiempo, para hacer seguimiento a su operación puede hacer un consumo cada 5 minutos de la información.

Métodos

<Tabs> <Tab name = "API Consulta (GET) "> GET/users

EndPoint: https://www.apis.serpi.com.co/api/v1/Sucursales

Headers

Header	Descripción
secretkey	Secretkey proporcionada al cliente para consumos de las APIs

Authorization:

Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP

Parámetros

Parámetro	Tipo de dato	Requerido	Descripción
Límite	int	No	Este parámetro indica la cantidad de resultados que se deben devolver en una sola página
Página	int	No	Este parámetro indica el número de la página que se debe devolver. Por ejemplo, si se establece en 3, se devolverán los resultados de la tercera página

Response

{
"success": true
	"success": true,
    "code": 200,
    "errors": null,
    "message": "x registro(s) encontrados",
    "result": [
        {
            "id": 2317,
            "id_tercero": 1804,
            "nit_tercero": "900985549",
            "codigo": 0,
            "referencia_sucursal": "",
            "descripcion": "PRUEBA",
            "direccion": "cra 22 # 4-44",
            "direccion2": "",
            "telefono": "",
            "telefono2": "",
            "ext": null,
            "ext2": null,
            "movil": "",
            "id_ciudad": 5001,
            "codigo_ciudad": "05001",
            "id_departamento": 5,
            "codigo_departamento": "05",
            "id_pais": 1,
            "codigo_pais": "57",
            "id_vendedor": 3418,
            "id_cobrador": null,
            "es_direccionCobro": false,
            "es_direccionDespacho": false
        },
	]
}

{
	"success": true
	"code": 201,
	"message": "No se encontraron registros",
	"result": []
}

Campo de resultados

Campo	Tipo de dato	Descripción
id	int	Corresponde al identificador de la sucursal
id_tercero	int	Corresponde al identificador del tercero
nit_tercero	int	Nit del tercero
codigo	string	Codigo de la sucursal
referencia_sucursal	string	Referencia de la sucursal
descripcion	string	Descripcion de la sucursal
direccion	string	Direccion de la sucursal
direccion2	string	Segunda direccion de la sucursal
telefono	int	Telefono correspondiente a la sucursal
telefono2	int	Segundo telefono correspondiente a la sucursal
ext	int	Extension de la sucursal
ext2	int	Extension de la sucursal
movil	int	Celular de la sucursal
id_ciudad	int	Identificador correspondiente a la ciudad de la sucursal
codigo_ciudad	string	Codigo de la ciudad de la sucursal
id_departamento	int	Identificador correspondiente al departamento de la sucursal
codigo_departamento	string	Codigo del departamento de la sucursal
id_pais	int	Identificador correspondiente al pais de la sucursal
codigo_pais	string	Codigo del pais de la sucursal
id_vendedor	int	Identificador correspondiente al vendedor de la sucursal
id_cobrador	int	Identificador correspondiente al cobrador de la sucursal
es_direccionCobro	bool	Valida si es direccion de cobro
es_direccionDespacho	bool	Valida si es direccion de despacho

</Tab>

<Tab name = "API Consulta (GET) "> GET/users