API Correios dengan PHP v2.0

Persyaratan

Komposer
PHP >= 8.2

Paket

luannsr12/sdkcorreios

API ini mencakup layanan berikut:

Layanan yang ditawarkan oleh Kantor Pos;
Perhitungan biaya pengiriman suatu produk;
Melacak pesanan;
Mengembalikan arti akronim yang terdapat dalam kode pelacakan.

Cara menggunakan API

Di bawah ini adalah petunjuk penggunaan:

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

Setelah mengunduh dan menginstal, edit file "config.php" dan tambahkan Access Token aplikasi Anda. Token Akses ini harus diteruskan di header permintaan API.

Semua titik akhir

Lacak pesanan

Titik akhir: /correios/tracking/
Metode: POSTING

Keriting:

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

Tubuh:

penyedia adalah opsional. Secara default, situs pencariannya adalah Pelacakan Terbaik. Lihat dokumentasi SDK untuk melihat penyedianya: Sdk Correios

 { "objek": ["QQ588651634BR"], "penyedia": "Muambator"}

Tanggapan:

 {"sukses": benar,"hasil": [
        {"code": "QQ588651634BR","status": "MOVEMENT","service_provider": "api.melhorrastreio.com.br","data": [
                {"date": "03-09-2024 07:27:10","to": "Unit Distribusi - MARECHAL CANDIDO RONDON/PR","from": "Unit Perawatan - CURITIBA/PR","lokasi ": "Unit Pemrosesan - CURITIBA/PR","originalTitle": "Objek sedang ditransfer - harap tunggu","details": "Objek sedang ditransfer - harap tunggu"},
                {"tanggal": "06-03-2024 12:25:05","ke": "Unit Perawatan - CASCAVEL/PR","from": "Unit Perawatan - SOROCABA/SP","location": "Pengobatan Unit - SOROCABA/SP","originalTitle": "Objek sedang ditransfer - harap tunggu","details": "Objek sedang ditransfer - harap Tunggu"}
            ]
        }
    ]
}

Jenis layanan

Titik akhir: /correios/services/
Metode: DAPATKAN

Keriting:

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

Tanggapan:

 { "status": "sukses", "hasil": {"PAC": "04510","SEDEX": "04014","SEDEX 12": "04782","SEDEX 10": "04790","SEDEX Hari ini": "04804"
  }
}

Hitung Pengiriman

Titik akhir: /correios/hitung/
Metode: DAPATKAN

Untuk jenis pesanan, ikuti definisi di bawah ini:

Kotak/Paket (1);
Rol/Prisma (2);
Amplop (3);

Catatan penting:

Jika itu Amplop, masukkan 0 pada saat itu;
Jika itu adalah Amplop, beratnya tidak boleh melebihi 1kg;
Jika berupa Roll/Prism, informasikan diameter kemasannya;
Jika Roll/Prisma, masukkan tinggi dan lebar 0;
Jika Kotak/Paket, masukkan diameter 0;
Untuk layanan "Tangan Sendiri" dan/atau "Pemberitahuan Tanda Terima", masukkan "Y" - ya atau "N" - tidak;
Nilai yang Dinyatakan bersifat opsional, dan jika Anda tidak ingin mendeklarasikannya, masukkan 0;

Keriting:

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"
}'

Tubuh:

 { "layanan": "04510", "sumber": "12460-000", "penerima": "37530-000", "tipe": 1, "panjang": 20, "tinggi": 20, "lebar" : 20, "diameter": 0, "berat": 0,500, "tanganOwn": "s", "declaredvalue": 150, "pemberitahuan tanda terima": "s"}

Tanggapan:

 ^ 29.40", "ValorMaoPropria": "7.50", "ValorAvisoRecebimento": "6.35", "ValorValorDeclarado": "2.58", "Pengiriman Domisili": "Y", "SaturdayDelivery": "N", "obsFim": [], "Error": "0", "MsgError": []
    }
  }
}

Dapatkan akronim berdasarkan ID

Titik akhir: /correios/bendera/
Metode: DAPATKAN

Keriting:

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

Tubuh:

 {"Id": "AR"}

Tanggapan:

 {"success": true,"result": {"Id": "AR","Nama": "PENERIMAAN PENERIMAAN"}
}

Daftar semua akronim

Titik akhir: /correios/flags/
Metode: DAPATKAN

Keriting:

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

Tanggapan:

 {"success": true,"result": {"AL": {"name": "READING AGENTS"},"AR": {"name": "ACKNOWLEDGMENT OF RECEIPT"},"AS": {" name ": "PAC ORDER – SOSIAL ACTION"},"BE": {"name": "REMITANCE EKONOMI TANPA UDARA DIGITAL"},"BF": {"name": "PENGIRIMAN EKSPRES TANPA UDARA DIGITAL"}
    }
}