RAFE - Filetracker API

Filetracker API enables the retrieval of the processing status of customer's EDI files via HTTP.

Base URL: https://rafe.edicenter.de/filetracker

OPERATION	METHOD	PATH	REQUEST BODY	RESPONSE BODY
GetByDay	`GET`	`/filetracker/{YYYY}-{MM}-{DD}`	-	application/json
GetByMonth	`GET`	`/filetracker/{YYYY}-{MM}`	-	application/json

Path parameters are enclosed in curly braces {...}.

Authentication

Filetracker API is a private API that requires authenticated users. As authentication method it uses Basic authentication. You can obtain username and password from EDICENTER.

GetByDay

Retrieves Filetracker items whose processing timestamp falls within the specified day. The day begins at 00:00:00 and ends at 23:59:59.

Time zone is Central European Time (UTC+1) or Central European Summer Time (UTC+2) 🔗

GET `/filetracker/{YYYY}-{MM}-{DD}`

PARAMETERS

TYPE	NAME	DESCRIPTION
Path	`{YYYY}-{MM}-{DD}`	Calendar date in ISO 8601 format: {YYYY} indicates a four-digit year, 2018 through 9999. {MM} indicates a two-digit month of the year, 01 through 12. {DD} indicates a two-digit day of that month, 01 through 31. The date components are separated by a hyphen -

Example request:

curl -v --user USER01:P@$$w0rd https://rafe.edicenter.de/filetracker/2022-12-06

RESPONSE

STATUS CODE	BODY	DESCRIPTION
`200 OK`	application/json	JSON object
`400 Bad Request`	application/json	The error message indicates which error is present.

Example response (snippet):

{
	"queryName": "GetByDay",
	"queryParameters": "Year: 2022; Month: 12; Day: 8",
	"itemCount": 71,
	"items": [
	{
		"ediPartner": "ALDI Einkauf GmbH & Co. oHG",
		"direction": "RECEIVE",
		"messageType": "ORDERS",
		"fileToProcess": "3242423423425522@as2_sfsd_com",
		"processedFile": {
			"file": "USER01_ALDIDE_E_ORDERS_32342_4234552.out.out",
			"beginOfFile": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><transmission xmlns=\"http://www.edicenter.de/UNIDOC\"><sender>6333453455</sender><recipient>3434535345433</recipient><creation_date>2022-12-08</creation_date><creation_time>14:15:00</creation_time><is_te",
			"documentNumbers": "345234, 432342",
			"sentDateTime": "2022-12-08 15:17:56",
			"sentToAddress": "IP: XX.XXX.X.XX; Port: 55788"
		}
	},
	{
		...
	}
	... more items ...

items.direction: RECEIVE indicates that the user receives EDI files from his EDI partner. SEND indicates that the user sends EDI files to his EDI partner.

Any item object and processedFile property can be null.

GetByMonth

Retrieves Filetracker items whose processing timestamp falls within the specified month period. The month period begins on the first day of the month specified, at 00:00:00. The month period ends on the last day of the month specified, at 23:59:59.

The URL for GetByMonth is very similar to that of GetByDay. The only difference is the missing day.

PARAMETERS

TYPE	NAME	DESCRIPTION
Path	`{YYYY}-{MM}`	Calendar date in ISO 8601 format: {YYYY} indicates a four-digit year, 2018 through 9999. {MM} indicates a two-digit month of the year, 01 through 12. The date components are separated by a hyphen -

Example request:

curl -v --user USER01:P@$$w0rd https://rafe.edicenter.de/filetracker/2022-12

RESPONSE

STATUS CODE	BODY	DESCRIPTION
`200 OK`	application/json	JSON object like in `GetByDay`
`400 Bad Request`	application/json	The error message indicates which error is present.

The JSON response structure is exactly the same as in the GetByDay response.

Example response (items omitted):

{
  "queryName": "GetByMonth",
  "queryParameters": "Year: 2022; Month: 12",
  "itemCount": 290,
  "items": [ ... ]
}

To avoid unnecessary traffic, you should prefer GetByDay over GetByMonth.

If you want to test the connection without retrieving any data - specify a date far in the future e.g. /filetracker/9999-12. The response will have an empty items array.