BCR Export Protocol SHAPE 2012

Transcription

1 BCR Export Protocol SHAPE 2012 Business Card Reader sends HTTP POST multipart request optional HTTP authentication is supported, BASIC and DIGEST methods with the following parameters: command - Action performed with business card. Possible values: add, edit, delete. personfirstname - string with contact first name personmiddlename - string with contact middle name personlastname - string with contact last name phoneticfirstname - string with contact phonetic first name phoneticlastname - string with contact phonetic last name prefix - string with contact name prefix suffix - string with contact name suffix nickname - string with contact nickname companyname - string with contact company name job - string with contact job title department - string with contact department title notes - string with contact notes birthday - string with birth date in unix time phones - array of arrays with phone strings [phones] => Array [mobile] => Array [0] => [0] => s - array of arrays with strings [ s] => Array [0] => sales@company.com urls - array of arrays with with url strings [urls] => Array

2 [0] => otherinfo - array of strings. Contains whole recognized text in first element. Some other strings could be added later. [otherinfo] => Array [0] => SAMPLE COMPANY National Park phone mobile sales@company.conn website JOHN SMITH addresses - array of address dictionaries with keys country, city, zip, street. [addresses] => Array [zip] => [country] => United States [street] => National Park ims - array of instant messenger dictionaries with keys service, user. [ims] => Array [service] => ICQ [user] => sns - array of social network dictionaries with keys service, user. [sns] => Array [service] => facebook

3 [user] => JohnSmith dates - array of date dictionaries with keys label, date. Date is sent in unix time format. [dates] => Array [label] => Anniversary [date] => All parameters are UTF8-encoded. Image with photo of business card is sent as binary data in the last parameter with following header: [Content-Disposition: form-data; name="photo"; filename="photo.jpg ] [Content-Type: image/jpeg] Business Card Reader expects answer to this request with status code 200. Example HTTP request POST /test.php HTTP/1.1 Host: bcrtest.shapeservices.net User-Agent: BCR/2.2 CFNetwork/ Darwin/ Content-Length: Accept: */* Content-Type: multipart/form-data; boundary= xao1xqci Accept-Language: en-us Accept-Encoding: gzip, deflate Connection: keep-alive Content-Disposition: form-data; name="personfirstname" JOHN Content-Disposition: form-data; name="personlastname" SMITH Content-Disposition: form-data; name="companyname" Sample Company Content-Disposition: form-data; name="otherinfo[0]" SAMPLE COMPANY National Park 32415

4 phone mobile website JOHN SMITH Content-Disposition: form-data; name="addresses[0][zip]" Content-Disposition: form-data; name="addresses[0][country]" United States Content-Disposition: form-data; name="addresses[0][street]" National Park Content-Disposition: form-data; name="phones[mobile][0]" Content-Disposition: form-data; name="phones[work][0]" Content-Disposition: form-data; name=" s[work][0]" Content-Disposition: form-data; name="urls[work][0]" Content-Disposition: form-data; name="job" Content-Disposition: form-data; name="command" edit Content-Disposition: form-data; name="photo"; filename="photo.jpg" Content-Type: image/jpeg [[***BINARY DATA***]] -- Results in PHP $_FILES: [photo] => Array [name] => photo.jpg

5 [type] => image/jpeg [tmp_name] => /tmp/phpo54rnj [error] => 0 [size] => 0 $_POST [personfirstname] => JOHN [personlastname] => SMITH [companyname] => Sample Company [otherinfo] => Array [0] => SAMPLE COMPANY National Park phone mobile sales@company.conn website JOHN SMITH [addresses] => Array [zip] => [country] => United States [street] => National Park [phones] => Array [mobile] => Array [0] => [0] => [ s] => Array

6 [0] => [urls] => Array [0] => [job] => [command] => edit