PHP v2.0 を使用した Correios API

要件

作曲家
PHP >= 8.2

パッケージ

luannsr12/sdkcorreios

この API は次のサービスを対象としています。

郵便局が提供するサービス;
商品の送料の計算;
注文の追跡;
トラッキングコードに含まれる頭字語の意味を返します。

APIの使い方

以下は使用説明です。

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

ダウンロードしてインストールした後、「config.php」ファイルを編集し、アプリケーションのアクセストークンを追加します。このアクセストークンは API リクエストのヘッダーで渡す必要があります。

すべてのエンドポイント

トラック注文

エンドポイント: /correios/tracking/
メソッド: POST

カール:

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

体：

プロバイダーはオプションです。デフォルトでは、検索サイトは Best Tracking です。プロバイダーについては、SDK ドキュメントを参照してください: Sdk Correios。

 { "オブジェクト": ["QQ588651634BR"]、"プロバイダー": "Muambator"}

応答：

 {"成功": true,"結果": [
        {"コード": "QQ588651634BR","ステータス": "MOVEMENT","サービスプロバイダー": "api.melhorrastreio.com.br","データ": [
                {"date": "03-09-2024 07:27:10","to": "配給ユニット - MARECHAL CANDIDO RONDON/PR","from": "治療ユニット - CURITIBA/PR","location ": "処理ユニット - CURITIBA/PR","originalTitle": "オブジェクトを転送中 - お待ちください","details": "オブジェクト転送中 - お待ちください"},
                {"date": "03-06-2024 12:25:05","to": "治療ユニット - CASCAVEL/PR","from": "治療ユニット - SOROCABA/SP","location": "治療Unit - SOROCABA/SP","originalTitle": "転送中のオブジェクト - お待ちください","details": "転送中のオブジェクト - お待ちください 待って"}
            ]
        }
    ]
}

サービスの種類

エンドポイント: /correios/services/
メソッド: GET

カール:

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

応答：

 { "ステータス": "成功", "結果": {"PAC": "04510","SEDEX": "04014","SEDEX 12": "04782","SEDEX 10": "04790","SEDEX今日": "04804"
  }
}

送料を計算する

エンドポイント: /correios/calculate/
メソッド: GET

注文の種類については、以下の定義に従います。

ボックス/パッケージ (1);
ローラー/プリズム (2);
封筒 (3);

重要な注意事項:

エンベロープの場合は、この時点で 0 を入力します。
封筒の場合、重量は 1kg を超えることはできません。
ロール/プリズムの場合は、パッケージの直径をお知らせください。
Roll/Prisma の場合は、高さと幅に 0 を入力します。
ボックス/パッケージの場合は、直径に 0 を入力します。
「自分の手」および/または「受領通知」サービスの場合は、「Y」（はい）または「N」（いいえ）を入力します。
Declared 値はオプションであり、宣言したくない場合は 0 を入力します。

カール:

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

体：

 { "サービス": "04510"、"送信元": "12460-000"、"受信者": "37530-000"、"タイプ": 1、"長さ": 20、"高さ": 20、"幅" : 20、「直径」: 0、「重さ」: 0.500、「手持ち」: "s"、 "宣言値": 150、"受領通知": "s"}

応答：

 ^ 29.40"、"ValorMaoPropria": "7.50"、"ValorAvisoRecebimento": "6.35"、 "ValorValorDeclarado": "2.58"、"Domiciliar Delivery": "Y"、"Saturdaydelivery": "N"、 "obsFim": []、 "Error": "0"、 "MsgError": []
    }
  }
}

ID で頭字語を取得する

エンドポイント: /correios/flag/
メソッド: GET

カール:

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

体：

 {"ID": "AR"}

応答：

 {"成功": true,"結果": {"ID": "AR","名前": "受信確認"}
}

すべての頭字語をリストする

エンドポイント: /correios/flags/
メソッド: GET

カール:

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

応答：

 {"成功": true,"結果": {"AL": {"名前": "エージェントの読み取り"},"AR": {"名前": "受信確認"},"AS": {" 名前": "PAC 命令 – 社会的行動"},"BE": {"name": "デジタル エアを使用しない経済送金"},"BF": {"name": 「デジタルエアを使用しない速達配送」}
    }
}