API Correios с PHP v2.0

Требования

Композитор
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/
Метод: ПОСТ

Кудри:

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"], "провайдер": "Муамбатор"}

Ответ:

 {"успех": правда,"результат": [
        {"code": "QQ588651634BR", "status": "MOVEMENT", "service_provider": "api.melhorrastreio.com.br", "data": [
                {"date": "09.03.2024 07:27:10","to": "Распределительное отделение — MARECHAL CANDIDO RONDON/PR", from": Лечебное отделение — КУРИТИБА/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/
Метод: ПОЛУЧИТЬ

Кудри:

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/
Метод: ПОЛУЧИТЬ

Для типа заказа следуйте приведенным ниже определениям:

Коробка/пакет (1);
Ролик/Призма (2);
Конверт (3);

Важные примечания:

Если это конверт, введите 0 в то время;
Если это конверт, вес не может превышать 1 кг;
Если это рулон/призма, укажите диаметр упаковки;
Если это Roll/Prisma, введите 0 для высоты и ширины;
Если Коробка/Упаковка, введите 0 в диаметре;
Для услуг «Своими руками» и/или «Извещение о приемке» укажите «Д» – да или «Н» – нет;
Значение «Объявлено» является необязательным. Если вы не хотите его объявлять, введите 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, «handOwn»: «s», "declaredvalue": 150, "уведомление о получении": "s"}

Ответ:

 ^ 29.40", "ValorMaoPropria": "7.50", "ValorAvisoRecebimento": "6.35", "ValorValorDeclarado": "2.58", "Доставка на дом": "Y", "SaturdayDelivery": "N", "obsFim": [], "Error": "0", "MsgError": []
    }
  }
}

Получить аббревиатуру по идентификатору

Конечная точка: /correios/flag/
Метод: ПОЛУЧИТЬ

Кудри:

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

Тело:

 {"Идентификатор": "AR"}

Ответ:

 {"успех": true, "result": {"Id": "AR", "Name": "ПОДТВЕРЖДЕНИЕ ПОЛУЧЕНИЯ"}
}

Перечислить все сокращения

Конечная точка: /correios/flags/
Метод: ПОЛУЧИТЬ

Кудри:

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

Ответ:

 {"успех": правда,"результат": {"AL": {"имя": "ЧТЕНИЕ АГЕНТОВ"},"AR": {"имя": "ПОДТВЕРЖДЕНИЕ ПОЛУЧЕНИЯ"},"AS": {" имя ": "PAC ORDER – СОЦИАЛЬНЫЕ ДЕЙСТВИЯ"},"BE": {"name": "ЭКОНОМИЧЕСКИЕ ДЕНЕЖНЫЕ ПЕРЕВОДЫ БЕЗ ЦИФРОВОГО ВОЗДУХА"},"BF": {"name": «ЭКСПРЕСС-ДОСТАВКА БЕЗ ЦИФРОВОГО ЭФИРА»}
    }
}