Correios API con PHP v2.0

Requisitos

Compositor
PHP >= 8.2

Paquetes

luannsr12/sdkcorreios

Esta API cubre los siguientes servicios:

Servicios ofrecidos por Correos;
Cálculo del envío de un producto;
Seguimiento de un pedido;
Devuelve el significado de las siglas contenidas en el código de seguimiento.

Cómo utilizar la API

A continuación se muestran las instrucciones de uso:

 git clone https://github.com/luannsr12/api-correios/
 cd api-correios
 composer install

Después de descargar e instalar, edite el archivo "config.php" y agregue el token de acceso de su aplicación. Este token de acceso debe pasarse en el encabezado de las solicitudes de API.

Todos los puntos finales

Seguimiento del pedido

Punto final: /correios/tracking/
Método: ENVIAR

Chinos:

curl --location --request GET '{{base_url}}/correios/tracking' 
--header 'Access-token: SEU_ACCESS_TOKEN' 
--header 'Content-Type: application/json' 
--data '{
  "objects": ["QQ588651634BR"],
  "provider": "Muambator"
}'

Cuerpo:

El proveedor es opcional. De forma predeterminada, el sitio de búsqueda es Best Tracking. Consulte la documentación del SDK para ver los proveedores: Sdk Correios.

 { "objetos": ["QQ588651634BR"], "proveedor": "Muambator"}

Respuesta:

 {"éxito": verdadero, "resultado": [
        {"code": "QQ588651634BR","status": "MOVIMIENTO","service_provider": "api.melhorrastreio.com.br","data": [
                {"date": "09-03-2024 07:27:10","to": "Unidad de Distribución - MARECHAL CANDIDO RONDON/PR","from": "Unidad de Tratamiento - CURITIBA/PR","ubicación ": "Unidad de Procesamiento - CURITIBA/PR","originalTitle": "Objeto en transferencia - por favor espere","details": "Objeto en transferencia - por favor espere"},
                {"date": "06-03-2024 12:25:05","to": "Unidad de Tratamiento - CASCAVEL/PR","from": "Unidad de Tratamiento - SOROCABA/SP","ubicación": "Tratamiento Unidad - SOROCABA/SP","originalTitle": "Objeto en transferencia - por favor espere","details": "Objeto en transferencia - por favor esperar"}
            ]
        }
    ]
}

Tipos de servicios

Punto final: /correios/servicios/
Método: OBTENER

Chinos:

curl --location '{{base_url}}/correios/services' 
--header 'Access-token: SEU_ACCESS_TOKEN'

Respuesta:

 { "estado": "éxito", "resultado": {"PAC": "04510","SEDEX": "04014","SEDEX 12": "04782","SEDEX 10": "04790","SEDEX Hoy": "04804"
  }
}

Calcular envío

Punto final: /correios/calcular/
Método: OBTENER

Para el tipo de orden, siga las definiciones a continuación:

Caja/Paquete (1);
Rodillo/Prisma (2);
Sobre (3);

Notas importantes:

Si es Sobre, ingrese 0 en ese momento;
Si se trata de un Sobre, el peso no podrá exceder de 1kg;
Si es Rollo/Prisma, informar el diámetro del embalaje;
Si es Rollo/Prisma, ingrese 0 en alto y ancho;
Si es Caja/Paquete, ingrese 0 en diámetro;
Para los servicios "Mano propia" y/o "Aviso de recibo", ingrese "Y" - sí o "N" - no;
El valor declarado es opcional y si no desea declararlo ingrese 0;

Chinos:

curl --location '{{base_url}}/correios/calculate' 
--header 'Access-token: SEU_ACCESS_TOKEN' 
--header 'Content-Type: application/json' 
--data '{
	"servico": "04510",
	"origem": "85930-000",
	"destinatario": "85960-000",
	"tipo": 1,
	"comprimento": 20,
	"altura": 20,
	"largura": 20,
	"diametro": 0,
	"peso": 0.500,
	"maoPropria": "s",
	"valorDeclarado": 150,
	"avisoRecebimento": "s"
}'

Cuerpo:

 { "servicio": "04510", "fuente": "12460-000", "destinatario": "37530-000", "tipo": 1, "largo": 20, "alto": 20, "ancho" : 20, "diámetro": 0, "peso": 0,500, "handOwn": "s", "valor declarado": 150, "aviso de recibo": "s"}

Respuesta:

 ^ 29.40", "ValorMaoPropria": "7.50", "ValorAvisoRecebimento": "6.35", "ValorValorDeclarado": "2.58", "Entrega Domiciliar": "Y", "EntregaSábado": "N", "obsFim": [], "Error": "0", "MsgError": []
    }
  }
}

Obtenga las siglas por ID

Punto final: /correios/flag/
Método: OBTENER

Chinos:

curl --location --request GET '{{base_url}}/correios/flag' 
--header 'Access-token: SEU_ACCESS_TOKEN' 
--header 'Content-Type: application/json' 
--data '{
    "Id": "AR"
}'

Cuerpo:

 {"Identificación": "AR"}

Respuesta:

 {"éxito": true,"resultado": {"Id": "AR","Nombre": "ACUSE DE RECIBO"}
}

Listar todas las siglas

Punto final: /correios/flags/
Método: OBTENER

Chinos:

curl --location '{{base_url}}/correios/flags' 
--header 'Access-token: SEU_ACCESS_TOKEN'

Respuesta:

 {"éxito": true,"resultado": {"AL": {"nombre": "AGENTES DE LECTURA"},"AR": {"nombre": "ACUSE DE RECIBO"},"AS": {" nombre ": "ORDEN PAC – ACCIÓN SOCIAL"},"BE": {"name": "REMESA ECONÓMICA SIN AIRE DIGITAL"},"BF": {"name": "ENVÍO EXPRESS SIN AIRE DIGITAL"}
    }
}