API Correios avec PHP v2.0

Exigences

Compositeur
PHP >= 8.2

Forfaits

luannsr12/sdkcorreios

Cette API couvre les services suivants :

Services proposés par la Poste ;
Calcul des frais d'expédition pour un produit ;
Suivi d'une commande ;
Renvoie la signification des acronymes contenus dans le code de suivi.

Comment utiliser l'API

Ci-dessous les instructions d'utilisation :

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

Après le téléchargement et l'installation, modifiez le fichier "config.php" et ajoutez le jeton d'accès de votre application. Ce jeton d'accès doit être passé dans l'en-tête des requêtes API.

Tous les points de terminaison

Suivre la commande

Point de terminaison : /correios/tracking/
Méthode : POST

Boucles :

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

Corps:

Le fournisseur est facultatif. Par défaut, le site de recherche est Best Tracking. Consultez la documentation du SDK pour voir les fournisseurs : Sdk Correios.

 { "objets": ["QQ588651634BR"], "provider": "Muambator"}

Réponse:

 {"succès": vrai,"résultat": [
        {"code": "QQ588651634BR","status": "MOVEMENT","service_provider": "api.melhorrastreio.com.br","data": [
                {"date": "03-09-2024 07:27:10","to": "Unité de distribution - MARECHAL CANDIDO RONDON/PR","from": "Unité de traitement - CURITIBA/PR","localisation ": "Unité de traitement - CURITIBA/PR","originalTitle": "Objet en cours de transfert - veuillez patienter","details": "Objet en transfert - veuillez patienter"},
                {"date": "03-06-2024 12:25:05","to": "Unité de traitement - CASCAVEL/PR","from": "Unité de traitement - SOROCABA/SP","location": "Traitement Unit - SOROCABA/SP","originalTitle": "Objet en transfert - veuillez patienter","details": "Objet en transfert - s'il vous plaît attendez"}
            ]
        }
    ]
}

Types de prestations

Point de terminaison : /correios/services/
Méthode : OBTENIR

Boucles :

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

Réponse:

 { "statut": "succès", "résultat": {"PAC": "04510", "SEDEX": "04014", "SEDEX 12": "04782", "SEDEX 10": "04790", "SEDEX" Aujourd'hui": "04804"
  }
}

Calculer l'expédition

Point final : /correios/calculate/
Méthode : OBTENIR

Pour le type de commande, suivez les définitions ci-dessous :

Boîte/Paquet (1);
Rouleau/Prisme (2) ;
Enveloppe (3);

Remarques importantes :

S'il s'agit d'Enveloppe, entrez 0 à ce moment-là ;
S'il s'agit d'une Enveloppe, le poids ne peut pas dépasser 1 kg ;
S'il s'agit d'un Rouleau/Prisme, indiquer le diamètre de l'emballage ;
S'il s'agit de Roll/Prisma, entrez 0 en hauteur et en largeur ;
Si Boîte/Paquet, entrez 0 en diamètre ;
Pour les services « Propre main » et/ou « Avis de réception », entrez « O » – oui ou « N » – non ;
La valeur Déclarée est facultative, et si vous ne souhaitez pas la déclarer, entrez 0 ;

Boucles :

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

Corps:

 { "service": "04510", "source": "12460-000", "destinataire": "37530-000", "type": 1, "longueur": 20, "hauteur": 20, "largeur" : 20, "diamètre": 0, "poids": 0,500, "handOwn": "s", "valeur déclarée": 150, "avis de réception": "s"}

Réponse:

 ^ 29h40", "ValorMaoPropria": "7h50", "ValorAvisoRecebimento": "6h35", "ValorValorDeclarado": "2.58", "Livraison domiciliaire": "Y", "SaturdayDelivery": "N", "obsFim": [], "Error": "0", "MsgError": []
    }
  }
}

Obtenez l'acronyme par pièce d'identité

Point de terminaison : /correios/flag/
Méthode : OBTENIR

Boucles :

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

Corps:

 {"Identifiant": "AR"}

Réponse:

 {"success": true,"result": {"Id": "AR","Name": "ACCUSÉ DE RÉCEPTION"}
}

Lister tous les acronymes

Point de terminaison : /correios/flags/
Méthode : OBTENIR

Boucles :

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

Réponse:

 {"success": true,"result": {"AL": {"name": "AGENTS DE LECTURE"},"AR": {"name": "ACCUSÉ DE RÉCEPTION"},"AS": {" name ": "ORDRE PAC – ACTION SOCIALE"},"BE": {"name": "VERSEMENT ÉCONOMIQUE SANS AIR NUMÉRIQUE"},"BF": {"name": "EXPÉDITION EXPRESS SANS AIR NUMÉRIQUE"}
    }
}