siftlogic / api_sample_libraries Goto Github PK

We need an Erlang example.

Story Points 15

All examples should have an option to delete the results archive file after download.

Default for option is to not delete the results archive as the SiftLogic platform will automatically clean up archive files over 30 days old

Story Points: 30

Implemented in C# as that is the most common. It has been awhile since I have done the implementation so I will need to brush up on C# coding.

Story Points: 15

We need a PHP implementation.

Each language should have a version for easy install on it's environments most popular package manager. For Node.js this would be NPM which could be installed like:

npm install siftlogic-bulk-ftp-api --save-dev

And no more work would be necessary.

Story Points: 20

We need a node implementation.

1. Requires a "Live" API Key to work
2. use header "x-authorization: ApiKey" in all calls
3. Base Path: http://server:port/api/live/bulk

_Operations:_

GET:
http://server:port/api/live/bulk/
Lists all active, pending and completed jobs (which have not yet been deleted)

POST:
http://server:port/api/live/bulk/
This attempts to create a new job
Fields

• export_type "multi/single"
• notify_email "email address to notify when job complete"
• file: @;type=text/csv"
  Example responses:

Error: {"status":"error","remaining_credits":1,"error":"out_of_credits","msg":"Account out of credits, please contact Sales"}
Success: {"status":"success","job":"sample_subscriber_data_csv","msg":"Successful upload of sample_subscriber_data.csv for processing","status_url":"http://localhost:82/api/live/bulk/sample_subscriber_data_csv"}

GET:
http://server:port/api/live/bulk/JOB
Gets the status of the JOB
Sample responses

{"job":"sample_subscriber_data_csv","added":"2014-06-20 18:09:46 UTC","started":"2014-06-20 18:09:47 UTC","status":"active"}
{"job":"sample_subscriber_data_csv","added":"2014-06-20 18:09:46 UTC","started":"2014-06-20 18:09:47 UTC","status":"active"}
{"job":"sample_subscriber_data_csv","added":"2014-06-20 18:09:46 UTC","started":"2014-06-20 18:09:47 UTC","status":"active"}
{"download_url":"http://localhost:82/api/live/bulk/sample_subscriber_data_csv/download","job":"sample_subscriber_data_csv","added":"2014-06-20 18:09:46 UTC","started":"2014-06-20 18:09:47 UTC","ended":"2014-06-20 18:10:29 UTC","status":"completed"}

DELETE:
http://server:port/api/live/bulk/JOB
Deletes all files associated with the JOB from the server

GET:
http://server:port/api/live/bulk/JOB/download
This initiates download of the results archive

We need a Java implementation.

We need a Python implementation.

Story Points: 15

We need a Ruby implementation.