Correios-API mit PHP v2.0

Anforderungen

Komponist
PHP >= 8.2

Pakete

luannsr12/sdkcorreios

Diese API deckt die folgenden Dienste ab:

Von der Post angebotene Dienstleistungen;
Berechnung des Versands für ein Produkt;
Verfolgung einer Bestellung;
Gibt die Bedeutung der im Tracking-Code enthaltenen Akronyme zurück.

So verwenden Sie die API

Nachfolgend finden Sie die Gebrauchsanweisung:

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

Bearbeiten Sie nach dem Herunterladen und Installieren die Datei „config.php“ und fügen Sie das Zugriffstoken Ihrer Anwendung hinzu. Dieses Zugriffstoken muss im Header von API-Anfragen übergeben werden.

Alle Endpunkte

Bestellung verfolgen

Endpunkt: /correios/tracking/
Methode: POST

Locken:

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

Körper:

Anbieter ist optional. Standardmäßig ist die Suchseite Best Tracking. Informationen zu den Anbietern finden Sie in der SDK-Dokumentation: Sdk Correios

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

Antwort:

 {"success": true,"result": [
        {"code": "QQ588651634BR", "status": "MOVEMENT", "service_provider": "api.melhorrastreio.com.br", "data": [
                {"Datum": "03-09-2024 07:27:10", "An": "Vertriebseinheit - MARECHAL CANDIDO RONDON/PR", "Von": "Behandlungseinheit - CURITIBA/PR", "Standort": „Verarbeitungseinheit – CURITIBA/PR“, „originalTitle“: „Objekt wird übertragen – bitte warten“, „details“: „Objekt in Übertragung - bitte warten"},
                {"Datum": "03-06-2024 12:25:05", "An": "Behandlungseinheit - CASCAVEL/PR", "Von": "Behandlungseinheit - SOROCABA/SP", "Standort": "Behandlung Einheit – SOROCABA/SP“, „originalTitle“: „Objekt in Übertragung – bitte warten“, „details“: „Objekt in Übertragung – bitte Warten"}
            ]
        }
    ]
}

Arten von Dienstleistungen

Endpunkt: /correios/services/
Methode: GET

Locken:

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

Antwort:

 { "status": "success", "result": {"PAC": "04510", "SEDEX": "04014", "SEDEX 12": "04782", "SEDEX 10": "04790", "SEDEX Heute“: „04804“
  }
}

Versandkosten berechnen

Endpunkt: /correios/calculate/
Methode: GET

Befolgen Sie für die Art der Bestellung die folgenden Definitionen:

Karton/Paket (1);
Rolle/Prisma (2);
Umschlag (3);

Wichtige Hinweise:

Wenn es sich um einen Umschlag handelt, geben Sie zu diesem Zeitpunkt 0 ein.
Handelt es sich um einen Umschlag, darf das Gewicht 1 kg nicht überschreiten;
Wenn es sich um eine Rolle/ein Prisma handelt, geben Sie bitte den Durchmesser der Verpackung an.
Wenn es sich um Roll/Prisma handelt, geben Sie 0 für Höhe und Breite ein;
Geben Sie bei Karton/Paket den Durchmesser 0 ein;
Geben Sie für die Dienste „Eigene Hand“ und/oder „Empfangsbenachrichtigung“ „J“ – ja oder „N“ – nein ein;
Der deklarierte Wert ist optional. Wenn Sie ihn nicht deklarieren möchten, geben Sie 0 ein.

Locken:

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

Körper:

 { „service“: „04510“, „source“: „12460-000“, „recipient“: „37530-000“, „type“: 1, „length“: 20, „height“: 20, „width“ : 20, „Durchmesser“: 0, „Gewicht“: 0,500, „handOwn“: „s“, „declaredvalue“: 150, „Receipt Notice“: „s“}

Antwort:

 ^ 29.40", "ValorMaoPropria": "7.50", "ValorAvisoRecebimento": "6.35", „ValorValorDeclarado“: „2.58“, „Domiciliar Delivery“: „Y“, „SaturdayDelivery“: „N“, „obsFim“: [], „Error“: „0“, „MsgError“: []
    }
  }
}

Erhalten Sie das Akronym anhand der ID

Endpunkt: /correios/flag/
Methode: GET

Locken:

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

Körper:

 {"Id": "AR"}

Antwort:

 {"success": true,"result": {"Id": "AR", "Name": "EMPFANGSBESTÄTIGUNG"}
}

Listen Sie alle Akronyme auf

Endpunkt: /correios/flags/
Methode: GET

Locken:

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

Antwort:

 {"success": true,"result": {"AL": {"name": "READING AGENTS"},"AR": {"name": "ACKNOWLEDGMENT OF RECEIPT"},"AS": {" name ": "PAC ORDER – SOCIAL ACTION"},"BE": {"name": "ECONOMIC REMITTANCE WITHOUT DIGITAL AIR"},"BF": {"name": „EXPRESSVERSAND OHNE DIGITALE LUFT“}
    }
}