화물API 개발/테스트 완료 후 아래 필수 서류를 첨부하셔야 사용가능합니다
공통 : 사업자등록증
운수사업자 : 주선,운송허가증
화물정보망 : 홈페이지 URL
공통 : 사업자등록증
운수사업자 : 주선,운송허가증
화물정보망 : 홈페이지 URL
화물API 계정생성하기
화물API는 계정이 승인된 회원에게만 제공됩니다
1. 아래 버튼을 클릭하셔서 계정생성을 해주세요
2. 로그인 승인시 계정생성시 입력한 Email로 승인 메일이 전송됩니다
3. 로그인 승인 메일에 포함된 화물API 서버IP주소를 사용자의 Endpoint 방화벽에 허용해주세요
4. 로그인 승인시 화물API 로그인이 가능합니다
5. 로그인시 아래의 API 접속 정보 및 Endpoint 설정 및 확인이 가능합니다
6. API 접속 정보는 계정 생성시 등록한 이메일로만 확인 가능합니다
7. 늘푸른화물정보 간편접수프로그램에 API계정으로 접속하여 연동정보 확인도 가능합니다
API계정만들기기본 정보
아이디
현재 패스워드
변경 패스워드
확인 패스워드
Email
회사명
사업자번호
접근 IP
접근 IP (추가)
접근 IP (추가)
API 사용 정보
인증정보 전송
MemberNum
SecretKey
API Token
만료기간
갱신용 Token
만료기간
사용자Endpoint
ContentType
API계정
사용자 구분
사용자 화물용 Endpoint
사용자 화물 접수
JSON
사용자 화물 수정
JSON
사용자 화물 취소
JSON
사용자 화물 재접수
JSON
사용자 화물 배차요청
사용자 화물 배차취소요청
사용자 화물 재배차요청
JSON
공유 화물용 EndPoint
공유 화물 접수
공유 화물 수정
공유 화물 취소
공유 화물 재접수
공유 화물 배차요청
JSON
공유 화물 배차취소 요청
JSON
공유 화물 재배차요청
Run : Endpoint 활성화
Stop : Endpoint 비활성화
※Endpoint 비인증 상태에서는 Run 동작과 상관없이 비활성화처리됩니다
Stop : Endpoint 비활성화
※Endpoint 비인증 상태에서는 Run 동작과 상관없이 비활성화처리됩니다
Endpoint 연결 테스트
화물API와 Endpoint간 연결 상태를 확인합니다
1. 로그인 후 내정보에서 아래와 같이 각 Endpoint 연결테스트 가능합니다
2. 사용자 서버의 방화벽 체크에 활용해주세요
3. UTF-8 인코딩 데이터가 정상적으로 수신되는지 확인해 주세요
4. 응답시에는 결과값이 팝업으로도 표시됩니다
5. 연결 테스트용은 기본 TimeOut (500ms) 입니다
API계정만들기배차 Endpoint 연결테스트 (예)
전송 테스트 시작
EndPoint
ContentType
Action Name
ActionName
연계 화물정보
화물아이디( ID )
운송료( Fee )
수수료( Commission )
화물버전( VersionNumber )
배차할 차량정보
회사명( DriverCompanyName )
사업자번호( DriverCompanyNumber )
차주명( DriverName )
차주연락처( DriverTel )
차량번호( DriverCarNumber )
차종( DriverCar )
톤수( DriverTon )
수신 응답시 HTTP상태코드입니다
HTTP상태코드
200
그 외
화물 접수하기
1. 차량이 필요한 화물을 접수합니다
2. 미승인 상태일 경우에는 차량회원들에게 해당 화물정보가 노출되지 않습니다
3. 승인이 완료되면 승인이 완료된 이후에 접수되는 화물부터 적용됩니다
화물API 접수 Endpoint
접속 URI
Content-Type
method
Header
Authorization
MemberNum
SecretKey
예 .net)
using (HttpClient client = new HttpClient())
{
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", "API 접속 계정의 Token정보");
client.DefaultRequestHeaders.Add("MemberNum","API 접속 계정의 MemberNum");
client.DefaultRequestHeaders.Add("SecretKey", "API 접속 계정의 SecretKey");
.......
.......
전송처리
}
Request Data (필수 항목 녹색 표시)
파라메터명
타입
크기
ID
문자열
50
VersionNumber
숫자
1000
VersionNumber는 배차요청이 발생될 경우 요청한 화물이 최신의 화물정보인지 검증에 활용할 수 있습니다.
화물API 사용자가 접수/수정시 함께 등록한 VersionNumber는 배차요청시 사용자 Endpoint로 함께 전송됩니다.
화물API 사용자는 전송받은 VersionNumber를 통해서 배차요청자가 요구하는 화물이 최신의 화물정보인지 검증 가능합니다.
화물API 사용자가 접수/수정시 함께 등록한 VersionNumber는 배차요청시 사용자 Endpoint로 함께 전송됩니다.
화물API 사용자는 전송받은 VersionNumber를 통해서 배차요청자가 요구하는 화물이 최신의 화물정보인지 검증 가능합니다.
UpLoadDate
문자열
8
UpLoadSido
문자열
2
시도 정보는 아래처럼 두 글자로 입력)
강원,경기,경남,경북,광주,대구,대전,서울,세종,울산,인천,전남,전북,제주,충남,충북,부산
강원,경기,경남,경북,광주,대구,대전,서울,세종,울산,인천,전남,전북,제주,충남,충북,부산
UpLoadName
문자열
30
UpLoadTime
문자열
5
UpLoadType
문자열
4
DnLoadDate
문자열
8
DnLoadSido
문자열
2
시도 정보는 아래처럼 두 글자로 입력)
강원,경기,경남,경북,광주,대구,대전,서울,세종,울산,인천,전남,전북,제주,충남,충북,부산
강원,경기,경남,경북,광주,대구,대전,서울,세종,울산,인천,전남,전북,제주,충남,충북,부산
DnLoadName
문자열
30
DnLoadTime
문자열
5
DnLoadType
문자열
4
Ton
문자열
10
톤수는 아래에서 택1)
0.3T / 0.5T / 1T / 1.4T / 2.5T / 3.5T / 5T / 5T축 / 5T플러스 / 5T플러스축 / 8T / 11T / 14T / 18T / 25T
0.3T / 0.5T / 1T / 1.4T / 2.5T / 3.5T / 5T / 5T축 / 5T플러스 / 5T플러스축 / 8T / 11T / 14T / 18T / 25T
예를 들어 화물의 중량이 2Ton ~ 2.5Ton 사이라면 2.5T를 선택합니다
.5T축이란 ? 5T차량에 차체를 좌우로 가르지르는 바퀴축이 추가된 차량으로 중량5T 이상 운반 가능
.5T플러스란 ? 적재함 길이가 7000 mm ~ 7300mm인 차량
.5T축이란 ? 5T차량에 차체를 좌우로 가르지르는 바퀴축이 추가된 차량으로 중량5T 이상 운반 가능
.5T플러스란 ? 적재함 길이가 7000 mm ~ 7300mm인 차량
Car
문자열
10
차종은 아래에서 택1)
카고 , 라보 , 다마스 , 카고/윙 , 호로 , 윙바디
탑차 , 냉동차 , 냉장차 , 카고리프트 , 윙리프트 , 탑리프트 ,방통차 ,추레라
카고 , 라보 , 다마스 , 카고/윙 , 호로 , 윙바디
탑차 , 냉동차 , 냉장차 , 카고리프트 , 윙리프트 , 탑리프트 ,방통차 ,추레라
카고? 지붕 없는 화물칸을 가진 차량
윙바디? 화물칸이 박스로 되어 있고 옆문(윙)/뒷문 개방이 가능한 차량
카고/윙? 카고 또는 윙바디 둘 다 가능
탑? 화물칸이 박스로 되어 있고 뒷문 개방만 가능한 차량
호로? 카고 차량에 화물칸을 덮을 수 있는 천막이 있는 차량
냉동? 적재함이 박스로 되어 있고 냉동기능이 있는 차량
냉장? 적재함이 박스로 되어 있고 냉장기능이 있는 차량
리프트? 적재함에 리프트(상하작동 운반구) 장치가 설치되어 있는 차량
방통차? 지붕 없는 화물칸에 크레인이 장착된 차량
윙바디? 화물칸이 박스로 되어 있고 옆문(윙)/뒷문 개방이 가능한 차량
카고/윙? 카고 또는 윙바디 둘 다 가능
탑? 화물칸이 박스로 되어 있고 뒷문 개방만 가능한 차량
호로? 카고 차량에 화물칸을 덮을 수 있는 천막이 있는 차량
냉동? 적재함이 박스로 되어 있고 냉동기능이 있는 차량
냉장? 적재함이 박스로 되어 있고 냉장기능이 있는 차량
리프트? 적재함에 리프트(상하작동 운반구) 장치가 설치되어 있는 차량
방통차? 지붕 없는 화물칸에 크레인이 장착된 차량
Weight
문자열
5
Type
문자열
2
독차 : 타 화물 혼합 적재 운송을 금지
혼적 : 타 화물 혼합 적재 운송을 허용
혼적 : 타 화물 혼합 적재 운송을 허용
Len
문자열
5
Memo
문자열
200
PayType
문자열
3
인수증 : 인수증 취득 후 세금계산서 발급시 운임을 지급
선착불 : 출발지 혹은 도착지에서 운임을 지급
선착불 : 출발지 혹은 도착지에서 운임을 지급
Fee
숫자
Commission
숫자
선착불 수수료는 API등록시 지정한 계좌로
배차완료일이 일요일~토요일까지의 수수료를 모아 다음 수요일 일괄 지급대행합니다
(수수료 지급대행 미가입자는 제외)
배차완료일이 일요일~토요일까지의 수수료를 모아 다음 수요일 일괄 지급대행합니다
(수수료 지급대행 미가입자는 제외)
IsWait
문자열
1
Y : 화물정보가 차량에 노출되지 않으며 차량 배차가 되지 않습니다. (화물이 보류된 상태등일 경우 사용)
N : 화물정보가 차량에 다시 노출되며 화물 배차가 가능합니다.
※내정보의 [API계정 상태]가 (미승인)일 경우에는 입력값에 관계없이 Y(대기)로 설정됩니다.
N : 화물정보가 차량에 다시 노출되며 화물 배차가 가능합니다.
※내정보의 [API계정 상태]가 (미승인)일 경우에는 입력값에 관계없이 Y(대기)로 설정됩니다.
CompanyName
문자열
30
ConnectPhone
문자열
11
만약 입력값이 대한민국 연락처 형식이 아닌경우 접수/수정 실패처리됩니다
HostName
문자열
30
해당 정보는 외부로 노출되지 않으며 화물배차시 문제가 발생되었을 경우 연락망으로 사용됩니다
HostTel
문자열
11
해당 정보는 외부로 노출되지 않으며 화물배차시 문제가 발생되었을 경우 연락망으로 사용됩니다
만약 입력값이 대한민국 연락처 형식이 아닌경우 접수/수정 실패처리됩니다
만약 입력값이 대한민국 연락처 형식이 아닌경우 접수/수정 실패처리됩니다
Request Data (전자)세금계산서정보 : 선택항목
(전자)세금계산서정보는 배차 완료시 차주에게 제공됩니다
(전자)세금계산서정보는 인수증 화물에만 노출됩니다
(전자)세금계산서정보는 인수증 화물에만 노출됩니다
CustCompanyName
문자열
50
CustCompanyNumber
문자열
10
CustBossName
문자열
20
CustTel
문자열
11
CustCompanyFax
문자열
11
CustCompanyEmail
문자열
50
CustCompanyBizKind
문자열
20
CustCompanyBizType
문자열
20
CustCompanyAddress
문자열
200
CustPostCode
문자열
10
응답 HTTP상태코드
HTTP상태코드
200
400
401
402
403
500
응답 메세지 (포멧JSON)
요청값 필수 혹은 타입(형식) 검증 실패
다음은 JSON 형식의 결과 메시지 예입니다
HttpStatusCode 400 이고 아래의 메세지를 전달합니다.
{
"errors":
{
"PayType":
[
"The PayType field is required.",
"The field PayType must be a string with a minimum length of 3 and a maximum length of 3."
]
},
"title":"One or more validation errors occurred.",
"status":400,
"traceId":"800000ee-0000-fd00-b63f-84710c7967bb"
}
그외
다음은 JSON 형식의 결과 메시지 예입니다
HttpStatusCode 200 이고 아래의 메세지를 전달합니다.
{
"code":"000",
"message":"success"
}
HttpStatusCode 400 이고 아래의 메세지를 전달합니다.
{
"code":"011",
"message":"Weight validation failed: 최대값은 해당 톤수의 105%를 넘을 수 없습니다"
}
화물 수정하기
1. 접수한 화물의 정보가 변동되었을 경우 수정합니다
2. 미승인 상태일 경우에는 차량회원들에게 해당 화물정보가 노출되지 않습니다
3. 승인이 완료되면 승인이 완료된 이후에 수정되는 화물부터 적용됩니다
화물API 수정 Endpoint
접속 URI
Content-Type
method
Header
Authorization
MemberNum
SecretKey
예 .net)
using (HttpClient client = new HttpClient())
{
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", "API 접속 계정의 Token정보");
client.DefaultRequestHeaders.Add("MemberNum","API 접속 계정의 MemberNum");
client.DefaultRequestHeaders.Add("SecretKey", "API 접속 계정의 SecretKey");
.......
.......
전송처리
}
Request Data (필수 항목 녹색 표시)
파라메터명
타입
크기
ID
문자열
50
VersionNumber
숫자
1000
VersionNumber는 배차요청이 발생될 경우 요청한 화물이 최신의 화물정보인지 검증에 활용할 수 있습니다.
화물API 사용자가 접수/수정시 함께 등록한 VersionNumber는 배차요청시 사용자 Endpoint로 함께 전송됩니다.
화물API 사용자는 전송받은 VersionNumber를 통해서 배차요청자가 요구하는 화물이 최신의 화물정보인지 검증 가능합니다.
화물API 사용자가 접수/수정시 함께 등록한 VersionNumber는 배차요청시 사용자 Endpoint로 함께 전송됩니다.
화물API 사용자는 전송받은 VersionNumber를 통해서 배차요청자가 요구하는 화물이 최신의 화물정보인지 검증 가능합니다.
UpLoadDate
문자열
8
UpLoadSido
문자열
2
시도 정보는 아래처럼 두 글자로 입력)
강원,경기,경남,경북,광주,대구,대전,서울,세종,울산,인천,전남,전북,제주,충남,충북,부산
강원,경기,경남,경북,광주,대구,대전,서울,세종,울산,인천,전남,전북,제주,충남,충북,부산
UpLoadName
문자열
30
UpLoadTime
문자열
5
UpLoadType
문자열
4
DnLoadDate
문자열
8
DnLoadSido
문자열
2
시도 정보는 아래처럼 두 글자로 입력)
강원,경기,경남,경북,광주,대구,대전,서울,세종,울산,인천,전남,전북,제주,충남,충북,부산
강원,경기,경남,경북,광주,대구,대전,서울,세종,울산,인천,전남,전북,제주,충남,충북,부산
DnLoadName
문자열
30
DnLoadTime
문자열
5
DnLoadType
문자열
4
Ton
문자열
10
톤수는 아래에서 택1)
0.3T / 0.5T / 1T / 1.4T / 2.5T / 3.5T / 5T / 5T축 / 5T플러스 / 5T플러스축 / 8T / 11T / 14T / 18T / 25T
0.3T / 0.5T / 1T / 1.4T / 2.5T / 3.5T / 5T / 5T축 / 5T플러스 / 5T플러스축 / 8T / 11T / 14T / 18T / 25T
예를 들어 화물의 중량이 2Ton ~ 2.5Ton 사이라면 2.5T를 선택합니다
.5T축이란 ? 5T차량에 차체를 좌우로 가르지르는 바퀴축이 추가된 차량으로 중량5T 이상 운반 가능
.5T플러스란 ? 적재함 길이가 7000 mm ~ 7300mm인 차량
.5T축이란 ? 5T차량에 차체를 좌우로 가르지르는 바퀴축이 추가된 차량으로 중량5T 이상 운반 가능
.5T플러스란 ? 적재함 길이가 7000 mm ~ 7300mm인 차량
Car
문자열
10
차종은 아래에서 택1)
카고 , 라보 , 다마스 , 카고/윙 , 호로 , 윙바디
탑차 , 냉동차 , 냉장차 , 카고리프트 , 윙리프트 , 탑리프트 ,방통차 ,추레라
카고 , 라보 , 다마스 , 카고/윙 , 호로 , 윙바디
탑차 , 냉동차 , 냉장차 , 카고리프트 , 윙리프트 , 탑리프트 ,방통차 ,추레라
카고? 지붕 없는 화물칸을 가진 차량
윙바디? 화물칸이 박스로 되어 있고 옆문(윙)/뒷문 개방이 가능한 차량
카고/윙? 카고 또는 윙바디 둘 다 가능
탑? 화물칸이 박스로 되어 있고 뒷문 개방만 가능한 차량
호로? 카고 차량에 화물칸을 덮을 수 있는 천막이 있는 차량
냉동? 적재함이 박스로 되어 있고 냉동기능이 있는 차량
냉장? 적재함이 박스로 되어 있고 냉장기능이 있는 차량
리프트? 적재함에 리프트(상하작동 운반구) 장치가 설치되어 있는 차량
방통차? 지붕 없는 화물칸에 크레인이 장착된 차량
윙바디? 화물칸이 박스로 되어 있고 옆문(윙)/뒷문 개방이 가능한 차량
카고/윙? 카고 또는 윙바디 둘 다 가능
탑? 화물칸이 박스로 되어 있고 뒷문 개방만 가능한 차량
호로? 카고 차량에 화물칸을 덮을 수 있는 천막이 있는 차량
냉동? 적재함이 박스로 되어 있고 냉동기능이 있는 차량
냉장? 적재함이 박스로 되어 있고 냉장기능이 있는 차량
리프트? 적재함에 리프트(상하작동 운반구) 장치가 설치되어 있는 차량
방통차? 지붕 없는 화물칸에 크레인이 장착된 차량
Weight
문자열
5
Type
문자열
2
독차 : 타 화물 혼합 적재 운송을 금지
혼적 : 타 화물 혼합 적재 운송을 허용
혼적 : 타 화물 혼합 적재 운송을 허용
Len
문자열
5
Memo
문자열
200
PayType
문자열
3
인수증 : 인수증 취득 후 세금계산서 발급시 운임을 지급
선착불 : 출발지 혹은 도착지에서 운임을 지급
선착불 : 출발지 혹은 도착지에서 운임을 지급
Fee
숫자
Commission
숫자
선착불 수수료는 API등록시 지정한 계좌로
배차완료일이 일요일~토요일까지의 수수료를 모아 다음 수요일 일괄 지급대행합니다
(수수료 지급대행 미가입자는 제외)
배차완료일이 일요일~토요일까지의 수수료를 모아 다음 수요일 일괄 지급대행합니다
(수수료 지급대행 미가입자는 제외)
IsWait
문자열
1
Y : 화물정보가 차량에 노출되지 않으며 차량 배차가 되지 않습니다. (화물이 보류된 상태등일 경우 사용)
N : 화물정보가 차량에 다시 노출되며 화물 배차가 가능합니다.
※내정보의 [API계정 상태]가 (미승인)일 경우에는 입력값에 관계없이 Y(대기)로 설정됩니다.
N : 화물정보가 차량에 다시 노출되며 화물 배차가 가능합니다.
※내정보의 [API계정 상태]가 (미승인)일 경우에는 입력값에 관계없이 Y(대기)로 설정됩니다.
CompanyName
문자열
30
ConnectPhone
문자열
11
만약 입력값이 대한민국 연락처 형식이 아닌경우 접수/수정 실패처리됩니다
Request Data (전자)세금계산서정보 : 선택항목
(전자)세금계산서정보는 배차 완료시 차주에게 제공됩니다
(전자)세금계산서정보는 인수증 화물에만 노출됩니다
(전자)세금계산서정보는 인수증 화물에만 노출됩니다
CustCompanyName
문자열
50
CustCompanyNumber
문자열
10
CustBossName
문자열
20
CustTel
문자열
11
CustCompanyFax
문자열
11
CustCompanyEmail
문자열
50
CustCompanyBizKind
문자열
20
CustCompanyBizType
문자열
20
CustCompanyAddress
문자열
200
CustPostCode
문자열
10
응답 HTTP상태코드
HTTP상태코드
200
400
401
402
403
500
응답 메세지 (포멧JSON)
요청값 필수 혹은 타입(형식) 검증 실패
다음은 JSON 형식의 결과 메시지 예입니다
HttpStatusCode 400 이고 아래의 메세지를 전달합니다.
{
"errors":
{
"PayType":
[
"The PayType field is required.",
"The field PayType must be a string with a minimum length of 3 and a maximum length of 3."
]
},
"title":"One or more validation errors occurred.",
"status":400,
"traceId":"800000ee-0000-fd00-b63f-84710c7967bb"
}
그외
다음은 JSON 형식의 결과 메시지 예입니다
HttpStatusCode 200 이고 아래의 메세지를 전달합니다.
{
"code":"000",
"message":"success"
}
HttpStatusCode 400 이고 아래의 메세지를 전달합니다.
{
"code":"011",
"message":"Weight validation failed: 최대값은 해당 톤수의 105%를 넘을 수 없습니다"
}
화물 취소하기
1. 접수한 화물이 취소되었거나 외 차량으로 배차되었을 경우 취소처리합니다
2. 취소를 하지 않을 경우 계속 접수 상태로 남아있기 때문에 중복 배차가 발생될 수 있습니다
3. 배차가 완료된 화물을 취소할 경우 이 후 다시 동일한 차량으로 재배차 처리도 가능합니다
화물API 취소 Endpoint
접속 URI
Content-Type
method
Header
Authorization
MemberNum
SecretKey
예 .net)
using (HttpClient client = new HttpClient())
{
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", "API 접속 계정의 Token정보");
client.DefaultRequestHeaders.Add("MemberNum","API 접속 계정의 MemberNum");
client.DefaultRequestHeaders.Add("SecretKey", "API 접속 계정의 SecretKey");
.......
.......
전송처리
}
Request Data (필수 항목 녹색 표시)
파라메터명
타입
크기
ID
문자열
50
응답 HTTP상태코드
HTTP상태코드
200
400
401
402
403
500
응답 메세지 (포멧JSON)
요청값 필수 혹은 타입(형식) 검증 실패
다음은 JSON 형식의 결과 메시지 예입니다
HttpStatusCode 400 이고 아래의 메세지를 전달합니다.
{
"errors":
{
"PayType":
[
"The PayType field is required.",
"The field PayType must be a string with a minimum length of 3 and a maximum length of 3."
]
},
"title":"One or more validation errors occurred.",
"status":400,
"traceId":"800000ee-0000-fd00-b63f-84710c7967bb"
}
그외
다음은 JSON 형식의 결과 메시지 예입니다
HttpStatusCode 200 이고 아래의 메세지를 전달합니다.
{
"code":"000",
"message":"success"
}
HttpStatusCode 400 이고 아래의 메세지를 전달합니다.
{
"code":"044",
"message":"이미 수수료 정산 처리된 화물입니다"
}
화물 재접수하기
1. 배차가 완료된 이 후 차주간 문제로 운행이 어려울경우 해당 화물을 다시 접수상태로 변경합니다
2. 배차가 완료된 화물을 재접수할 경우에는 접수상태로 변경되기 때문에 (차량 정보가 모두 소멸)
이 후 다시 동일한 차량으로 재배차 처리가 안됩니다
화물API 재접수 Endpoint
접속 URI
Content-Type
method
Header
Authorization
MemberNum
SecretKey
예 .net)
using (HttpClient client = new HttpClient())
{
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", "API 접속 계정의 Token정보");
client.DefaultRequestHeaders.Add("MemberNum","API 접속 계정의 MemberNum");
client.DefaultRequestHeaders.Add("SecretKey", "API 접속 계정의 SecretKey");
.......
.......
전송처리
}
Request Data (필수 항목 녹색 표시)
파라메터명
타입
크기
ID
문자열
50
응답 HTTP상태코드
HTTP상태코드
200
400
401
402
403
500
응답 메세지 (포멧JSON)
요청값 필수 혹은 타입(형식) 검증 실패
다음은 JSON 형식의 결과 메시지 예입니다
HttpStatusCode 400 이고 아래의 메세지를 전달합니다.
{
"errors":
{
"PayType":
[
"The PayType field is required.",
"The field PayType must be a string with a minimum length of 3 and a maximum length of 3."
]
},
"title":"One or more validation errors occurred.",
"status":400,
"traceId":"800000ee-0000-fd00-b63f-84710c7967bb"
}
그외
다음은 JSON 형식의 결과 메시지 예입니다
HttpStatusCode 200 이고 아래의 메세지를 전달합니다.
{
"code":"000",
"message":"success"
}
HttpStatusCode 400 이고 아래의 메세지를 전달합니다.
{
"code":"046",
"message":"수수료 정산된 화물은 재접수할 수 없습니다"
}
화물 재배차 요청하기
1. 차주간 문제로 취소된 화물을 다시 동일한 차주로 배차할 경우에 사용합니다
2. ex) 차주가 다시 운행이 가능해졌을 경우
3. ex) 화물을 잘 못 취소한 경우등
4. [주의]화물이 한 번이라도 재접수가 되었을 경우에는 다시 재배차 할 수 없습니다
화물API 재배차 Endpoint
접속 URI
Content-Type
method
Header
Authorization
MemberNum
SecretKey
예 .net)
using (HttpClient client = new HttpClient())
{
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", "API 접속 계정의 Token정보");
client.DefaultRequestHeaders.Add("MemberNum","API 접속 계정의 MemberNum");
client.DefaultRequestHeaders.Add("SecretKey", "API 접속 계정의 SecretKey");
.......
.......
전송처리
}
Request Data (필수 항목 녹색 표시)
파라메터명
타입
크기
ID
문자열
50
Fee
숫자
Commission
숫자
DriverCarNumber
문자열
9
응답 HTTP상태코드
HTTP상태코드
200
400
401
402
403
500
응답 메세지 (포멧JSON)
요청값 필수 혹은 타입(형식) 검증 실패
다음은 JSON 형식의 결과 메시지 예입니다
HttpStatusCode 400 이고 아래의 메세지를 전달합니다.
{
"errors":
{
"PayType":
[
"The PayType field is required.",
"The field PayType must be a string with a minimum length of 3 and a maximum length of 3."
]
},
"title":"One or more validation errors occurred.",
"status":400,
"traceId":"800000ee-0000-fd00-b63f-84710c7967bb"
}
그외
다음은 JSON 형식의 결과 메시지 예입니다
HttpStatusCode 200 이고 아래의 메세지를 전달합니다.
{
"code":"000",
"message":"success"
}
HttpStatusCode 400 이고 아래의 메세지를 전달합니다.
{
"code":"018",
"message":"차량의 충전금이 부족합니다"
}
화물 배차 요청하기
1. 공유화물을 배차할 경우 차량정보를 전송합니다
2. [주의]차주 사업자번호가 대한민국 사업자번호 형식이 아닌경우 실패처리됩니다
화물API 배차 Endpoint
접속 URI
Content-Type
method
Header
Authorization
MemberNum
SecretKey
예 .net)
using (HttpClient client = new HttpClient())
{
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", "API 접속 계정의 Token정보");
client.DefaultRequestHeaders.Add("MemberNum","API 접속 계정의 MemberNum");
client.DefaultRequestHeaders.Add("SecretKey", "API 접속 계정의 SecretKey");
.......
.......
전송처리
}
Request Data (필수 항목 녹색 표시)
파라메터명
타입
크기
ID
문자열
50
VersionNumber
숫자
1000
Fee
숫자
99999999
Commission
숫자
99999999
DriverCompanyName
문자열
20
DriverCompanyNumber
문자열
10
DriverName
문자열
20
DriverTel
문자열
11
DriverCarNumber
문자열
9
DriverCar
문자열
10
차주 차량 종류)
카고 , 라보 , 다마스 , 호로 , 윙바디
탑차 , 냉동차 , 냉장차 , 카고리프트 , 윙리프트 , 탑리프트 ,방통차 ,추레라
카고 , 라보 , 다마스 , 호로 , 윙바디
탑차 , 냉동차 , 냉장차 , 카고리프트 , 윙리프트 , 탑리프트 ,방통차 ,추레라
DriverTon
문자열
10
차주 차량 톤수 종류)
0.3T / 0.5T / 1T / 1.4T / 2.5T / 3.5T / 5T / 5T축 / 5T플러스 / 5T플러스축 / 8T / 11T / 14T / 18T / 25T
0.3T / 0.5T / 1T / 1.4T / 2.5T / 3.5T / 5T / 5T축 / 5T플러스 / 5T플러스축 / 8T / 11T / 14T / 18T / 25T
응답 HTTP상태코드
HTTP상태코드
200
400
401
402
403
500
응답 메세지 (포멧JSON)
배차 성공 (200 OK)
다음은 JSON 형식의 결과 메시지 예입니다
HttpStatusCode 400 이고 아래의 메세지를 전달합니다.
{
"connectphone":"차량을 요청한 업체의 연락처(숫자)",
"companyname":"차량을 요청한 업체명",
"custcompanyname":"(전자)세금계산서 회사명",
"custcompanynumber":"(전자)세금계산서 사업자번호(숫자)",
"custtel":"(전자)세금계산서 연락처",
"custbossName":"(전자)세금계산서 대표자명",
"custcompanyfax":"(전자)세금계산서 팩스번호",
"custcompanyemail":"(전자)세금계산서 이메일",
"custcompanybizkind":"(전자)세금계산서 업종",
"custcompanybiztype":"(전자)세금계산서 업태",
"custcompanyaddress":"(전자)세금계산서 주소",
"custpostcode":"(전자)세금계산서 우편번호"
}
(전자)세금계산서 정보는 {}비어있는 (null)값도 포함되며
선착불 화물인 경우에는 모두 (null)값 처리됩니다
(전자)세금계산서 정보는 {}비어있는 (null)값도 포함되며
선착불 화물인 경우에는 모두 (null)값 처리됩니다
요청값 필수 혹은 타입(형식) 검증 실패
다음은 JSON 형식의 결과 메시지 예입니다
HttpStatusCode 400 이고 아래의 메세지를 전달합니다.
{
"errors":
{
"PayType":
[
"The PayType field is required.",
"The field PayType must be a string with a minimum length of 3 and a maximum length of 3."
]
},
"title":"One or more validation errors occurred.",
"status":400,
"traceId":"800000ee-0000-fd00-b63f-84710c7967bb"
}
그외
다음은 JSON 형식의 결과 메시지 예입니다
HttpStatusCode 400 이고 아래의 메세지를 전달합니다.
{
"code":"017",
"message":"차종이 맞지 않습니다"
}
화물 배차취소 요청하기
1. 공유화물 배차후 배차취소를 희망하는 경우 사용합니다
2. 공유화물 배차후 3분안에만 가능하며 이후는 화물을 등록한 업체를 통해서만 취소가능합니다
화물API 배차취소요청 Endpoint
접속 URI
Content-Type
method
Header
Authorization
MemberNum
SecretKey
예 .net)
using (HttpClient client = new HttpClient())
{
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", "API 접속 계정의 Token정보");
client.DefaultRequestHeaders.Add("MemberNum","API 접속 계정의 MemberNum");
client.DefaultRequestHeaders.Add("SecretKey", "API 접속 계정의 SecretKey");
.......
.......
전송처리
}
Request Data (필수 항목 녹색 표시)
파라메터명
타입
크기
ID
문자열
50
DriverName
문자열
20
DriverTel
문자열
11
DriverCarNumber
문자열
9
응답 HTTP상태코드
HTTP상태코드
200
400
401
402
403
500
응답 메세지 (포멧JSON)
요청값 필수 혹은 타입(형식) 검증 실패
다음은 JSON 형식의 결과 메시지 예입니다
HttpStatusCode 400 이고 아래의 메세지를 전달합니다.
{
"errors":
{
"PayType":
[
"The PayType field is required.",
"The field PayType must be a string with a minimum length of 3 and a maximum length of 3."
]
},
"title":"One or more validation errors occurred.",
"status":400,
"traceId":"800000ee-0000-fd00-b63f-84710c7967bb"
}
그외
다음은 JSON 형식의 결과 메시지 예입니다
HttpStatusCode 200 이고 아래의 메세지를 전달합니다.
{
"code":"000",
"message":"success"
}
HttpStatusCode 400 이고 아래의 메세지를 전달합니다.
{
"code":"043",
"message":"배차 취소요청 실패"
}
공유화물 접수
1. 차량이 필요한 화물이 접수된 경우 사용자가 등록한 Endpoint로 공유합니다
2. ActionName에 create 값으로 전송됩니다
3. ActionName은 하나의 Endpoint로 처리시에 활용이 가능합니다
4. 사용자가 응답한 HTTP상태코드가 (200)성공이 아닌경우
사용자는 해당 화물을 배차요청하여도 배차거부(실패)처리됩니다
화물API 접수 Endpoint
접속 URI
Content-Type
method
Request Data (필수 전송되는 항목 녹색 표시)
파라메터명
타입
크기
ActionName
문자열
15
ID
문자열
50
VersionNumber
숫자
1000
UpLoadDate
문자열
8
UpLoadSido
문자열
2
UpLoadName
문자열
30
UpLoadTime
문자열
5
UpLoadType
문자열
4
DnLoadDate
문자열
8
DnLoadSido
문자열
2
DnLoadName
문자열
30
DnLoadTime
문자열
5
DnLoadType
문자열
4
Ton
문자열
10
Car
문자열
10
Weight
문자열
5
Type
문자열
2
Len
문자열
5
Memo
문자열
200
PayType
문자열
3
Fee
숫자
Commission
숫자
IsWait
문자열
1
Y : 대기 상태일 경우 배차요청시 배차실패처리됩니다
API 협력사(화물정보망) 회원용 (추가정보)
로그인 해주세요
사용자가 응답할 HTTP상태코드입니다
HTTP상태코드
200
그 외
공유화물 수정
1. 차량이 필요한 화물이 수정된 경우 사용자가 등록한 Endpoint로 공유합니다
2. ActionName에 update 값으로 전송됩니다
3. ActionName은 하나의 Endpoint로 처리시에 활용이 가능합니다
4. 사용자가 응답한 HTTP상태코드가 (200)성공이 아닌경우
사용자는 해당 화물을 배차요청하여도 배차거부(실패)처리됩니다
화물API 수정 Endpoint
접속 URI
Content-Type
method
Request Data (필수 전송되는 항목 녹색 표시)
파라메터명
타입
크기
ActionName
문자열
15
ID
문자열
50
VersionNumber
숫자
1000
UpLoadDate
문자열
8
UpLoadSido
문자열
2
UpLoadName
문자열
30
UpLoadTime
문자열
5
UpLoadType
문자열
4
DnLoadDate
문자열
8
DnLoadSido
문자열
2
DnLoadName
문자열
30
DnLoadTime
문자열
5
DnLoadType
문자열
4
Ton
문자열
10
Car
문자열
10
Weight
문자열
5
Type
문자열
2
Len
문자열
5
Memo
문자열
200
PayType
문자열
3
Fee
숫자
Commission
숫자
IsWait
문자열
1
Y : 대기 상태일 경우 배차요청시 배차실패처리됩니다
API 협력사(화물정보망) 회원용 (추가정보)
로그인 해주세요
사용자가 응답할 HTTP상태코드입니다
HTTP상태코드
200
그 외
공유화물 취소
1. 차량이 필요한 화물을 사용자가 취소한 경우 Endpoint로 공유합니다
2. ActionName에 cancel 값으로 전송됩니다
3. ActionName은 하나의 Endpoint로 처리시에 활용이 가능합니다
4. 사용자가 응답한 HTTP상태코드에 상관없이 Action 발생시 단 1회만 전송됩니다
화물API 취소 Endpoint
접속 URI
Content-Type
method
Request Data (필수 전송되는 항목 녹색 표시)
파라메터명
타입
크기
ActionName
문자열
15
ID
문자열
50
사용자가 응답할 HTTP상태코드입니다
HTTP상태코드
200
그 외
공유화물 재접수
1. 차량이 필요한 화물이 다시 재접수된 경우 사용자가 등록한 Endpoint로 공유합니다
2. ActionName에 reopen 값으로 전송됩니다
3. ActionName은 하나의 Endpoint로 처리시에 활용이 가능합니다
4. 사용자가 응답한 HTTP상태코드가 (200)성공이 아닌경우
사용자는 해당 화물을 배차요청하여도 배차거부(실패)처리됩니다
화물API 재접수 Endpoint
접속 URI
Content-Type
method
Request Data (필수 전송되는 항목 녹색 표시)
파라메터명
타입
크기
ActionName
문자열
15
ID
문자열
50
사용자가 응답할 HTTP상태코드입니다
HTTP상태코드
200
그 외
화물 재배차요청 받기
1. 공유화물을 배차 받고 취소된 경우 다시 화물등록 업체에서 재배차 요청시 발생합니다
2. 수신되는 HTTP상태코드에 따라 재배차성공 및 재배차실패 처리됩니다
3. 재배차 요청시 Fee(운임)는 상향 , Commission(수수료)는 하향 조정된 값이 전송될 수있습니다
상향,하향 조정된 Fee(운임) , Commission(수수료)는 자체적으로 변경처리되어야 합니다
4. 배차요청시에는 ActionName에 re_allocate 값으로 전송됩니다
5. ActionName은 하나의 Endpoint로 처리시에 활용이 가능합니다
화물API 재배차요청 Endpoint
접속 URI
Content-Type
method
Request Data (필수 전송되는 항목 녹색 표시)
파라메터명
타입
크기
ActionName
문자열
15
ID
문자열
50
Fee
숫자
99999999
Commission
숫자
99999999
DriverCarNumber
문자열
9
응답 HTTP상태코드입니다
HTTP상태코드
200
그 외
화물 배차요청 받기
1. 접수한 화물에 배차요청이 발생되면 등록한 Endpoint로 배차 요청한 차량정보를 전송합니다
2. 수신되는 HTTP상태코드에 따라 배차성공 및 배차실패 처리됩니다
3. 배차요청시에는 ActionName에 allocate 값으로 전송됩니다
4. ActionName은 하나의 Endpoint로 처리시에 활용이 가능합니다
화물API 배차요청 Endpoint
접속 URI
Content-Type
method
Request Data (필수 전송되는 항목 녹색 표시)
파라메터명
타입
크기
ActionName
문자열
15
ID
문자열
50
VersionNumber
숫자
1000
Fee
숫자
99999999
Commission
숫자
99999999
DriverCompanyName
문자열
20
DriverCompanyNumber
문자열
10
DriverName
문자열
20
DriverTel
문자열
11
DriverCarNumber
문자열
9
DriverCar
문자열
10
차주 차량 종류)
카고 , 라보 , 다마스 , 호로 , 윙바디
탑차 , 냉동차 , 냉장차 , 카고리프트 , 윙리프트 , 탑리프트 ,방통차 ,추레라
카고 , 라보 , 다마스 , 호로 , 윙바디
탑차 , 냉동차 , 냉장차 , 카고리프트 , 윙리프트 , 탑리프트 ,방통차 ,추레라
DriverTon
문자열
10
차주 차량 톤수 종류)
0.3T / 0.5T / 1T / 1.4T / 2.5T / 3.5T / 5T / 5T축 / 5T플러스 / 5T플러스축 / 8T / 11T / 14T / 18T / 25T
0.3T / 0.5T / 1T / 1.4T / 2.5T / 3.5T / 5T / 5T축 / 5T플러스 / 5T플러스축 / 8T / 11T / 14T / 18T / 25T
응답 HTTP상태코드입니다
HTTP상태코드
200
그 외
실패 응답 메세지 (선택사양)
(포멧JSON)
다음은 JSON 형식의 실패 응답 메시지 예입니다
{
"message":"이미 배차가 완료된 화물입니다"
}
화물 배차취소요청 받기
1. 배차받은 차량이 잘 못 배차요청을 하였을 경우에 사용됩니다
2. 배차받은 차량이 확인한 화물정보와 실제 화물정보가 다른경우 사용됩니다
3. 배차취소요청은 차주가 사용하며 배차 후 3분안에만 가능합니다
4. 수신되는 HTTP상태코드에 따라 취소요청성공 및 취소요청실패 처리됩니다
5. 배차취소요청시에는 ActionName에 allocate_cancel 값으로 전송됩니다
6. ActionName은 하나의 Endpoint로 처리시에 활용이 가능합니다
응답 HTTP상태코드 200인 경우 : 화물이 다시 재접수 상태로 변경됩니다
응답 HTTP상태코드 그 외 경우 : 화물은 취소요청상태 그대로 유지됩니다
※취소요청상태의 화물은 수수료 정산에서 제외되며
비동기적으로 재배차 요청 신호를 전송하셔야 다시 정산에 포함됩니다
※비동기적으로 처리하실 경우에는 해당 처리는 실패처리하신 후
비동기적으로 재접수/취소/재배차 신호를 다시 전송하시면 됩니다
응답 HTTP상태코드 그 외 경우 : 화물은 취소요청상태 그대로 유지됩니다
※취소요청상태의 화물은 수수료 정산에서 제외되며
비동기적으로 재배차 요청 신호를 전송하셔야 다시 정산에 포함됩니다
※비동기적으로 처리하실 경우에는 해당 처리는 실패처리하신 후
비동기적으로 재접수/취소/재배차 신호를 다시 전송하시면 됩니다
화물API 배차취소요청 Endpoint
접속 URI
Content-Type
method
Request Data (필수 전송되는 항목 녹색 표시)
파라메터명
타입
크기
ActionName
문자열
15
ID
문자열
50
DriverName
문자열
20
DriverTel
문자열
11
DriverCarNumber
문자열
9
응답 HTTP상태코드입니다
HTTP상태코드
200
그 외
승인요청
화물API 연계 테스트가 완료되면 아래 Email로 승인요청을 해주세요
Email : evergreeninfodev@15668365.com
제목 : 승인요청합니다
회사명 : 화물API 계정생성시 등록한 회사명
사업자번호 : 화물API 계정생성시 등록한 사업자번호
담당자명 : 담당자명
담당자연락처 : 연락 받을 번호
별도 연락 및 연계 테스트가 완료되면 화물API 승인이 완료됩니다
화물 API 응답 코드 리스트
| HTTP Status Code | code | message |
|---|---|---|
| 200 OK | 000 | success |
| 400 Bad Request | 003 | 요청 파라메터 정보를 다시 확인하세요 |
| 400 Bad Request | 010 | validation failed : 항목명 |
| 400 Bad Request | 011 | Weight validation failed: 최대값은 해당 톤수의 105%입니다(단위Ton) |
| 400 Bad Request | 012 | Len Over : 최대값은 30 입니다(단위m) |
| 401 Unauthorized | 001 | Unauthorized |
| 401 Unauthorized | 013 | MemberNum를 확인해주세요 |
| 402 PAYMENT_REQUIRED | 018 | 충전금이 부족합니다 |
| 402 PAYMENT_REQUIRED | 044 | 이미 수수료 정산 처리된 화물입니다(취소/수정/재접수등 변경불가) |
| 402 PAYMENT_REQUIRED | 045 | 현재 적립금 부족으로 취소할 수 없습니다 |
| 402 PAYMENT_REQUIRED | 046 | 수수료 정산된 화물은 재접수할 수 없습니다 |
| 403 Forbidden | 016 | 톤수가 맞지 않습니다 |
| 403 Forbidden | 017 | 톤수가 맞지 않습니다(배차실패) |
| 403 Forbidden | 016 | 차종이 맞지 않습니다(배차실패) |
| 403 Forbidden | 019 | 미결제 및 미등록회원입니다 |
| 403 Forbidden | 030 | 이미 존재하는 ID입니다 |
| 403 Forbidden | 031 | 존재하지 않는 ID입니다 |
| 403 Forbidden | 032 | 이미 배차완료된 화물입니다 |
| 403 Forbidden | 033 | 이미 취소된 화물입니다 |
| 403 Forbidden | 034 | 화물이 수정중이거나 내용이 변경되었습니다 |
| 403 Forbidden | 035 | 민원으로 배차 금지된 차량번호입니다 |
| 403 Forbidden | 036 | 하차날짜가 상차일보다 과거입니다 |
| 403 Forbidden | 037 | 화물 등록 실패 |
| 403 Forbidden | 038 | 접수상태 화물만 수정가능합니다 |
| 403 Forbidden | 039 | 화물 취소 실패 |
| 403 Forbidden | 040 | 화물 재접수 실패 |
| 403 Forbidden | 041 | 화물 배차 실패 |
| 403 Forbidden | 042 | 배차 복귀요청 실패 |
| 403 Forbidden | 043 | 배차 취소요청 실패 |
| 403 Forbidden | 044 | 이미 수수료 정산 처리된 화물입니다 |
| 403 Forbidden | 045 | 현재 적립금 부족으로 취소할 수 없습니다 |
| 403 Forbidden | 046 | 수수료 정산된 화물은 재접수할 수 없습니다 |
| 403 Forbidden | 047 | 동일한 톤수의 차량만 배차가능한 화물입니다 |
| 403 Forbidden | 048 | 화물중량 오류 |
| 403 Forbidden | 050 | 기타 오류 (실패) |
| 500 Internal Server Error | 002 | API 처리중 서버 오류가 발생되었습니다 |
| 500 Internal Server Error | 020 | API 처리중 서버 오류가 발생되었습니다 (WebServiceException) |
차량관제
내가 배차받은 차량의 최신 위치정보를 취득합니다
1. 차량관제는 출발일(상차일) ~ 도착일(하차일)기한에만 사용 가능합니다
2. 차량의 GPS가 꺼져있을경우 취득되지 않습니다
API계정만들기
차량관제 API는 내 API계정 정보 페이지에서
확인해 주세요
확인해 주세요
가상계좌
가상계좌 번호를 취득합니다
1. 공유화물(선착불) 배차전용 가상계좌입니다
2. 가상계좌 변경은 이메일문의로 변경가능합니다
3. 복수 가상계좌는 지원되지 않습니다
4. 적립금액이 0원일 경우 선착불건 배차시 제한됩니다
API계정만들기
가상계좌 API는 내 API계정 정보 페이지에서
확인해 주세요
확인해 주세요
적립금액 API는 내 API계정 정보 페이지에서
확인해 주세요
확인해 주세요
적립금내역 API는 내 API계정 정보 페이지에서
확인해 주세요
확인해 주세요
