devotis / node-clang-rest

RESTifies the Clang SOAP API

node-clang-rest

Node based JSON/HTTP proxy to the Clang's SOAP webservice API.

This is a restful webservice that proxies HTTP requests to Clang's SOAP API, passing along any parameters in the query string. All requests are proxied to Clang using HTTPS. Returns SOAP responses as JSON.

Token

Authentication to the Clang Webservice API is done using a token (uuid). Contact the Support Desk of your Clang reseller to obtain a token. Contact Leads to Loyals if you'd like to learn more about using Clang and this API.

Pass the token as an uuid header or a _uuid query parameter. The supplied token will be proxied to Clang with each request.

Usage

• GET /customers
• GET /customers/39515
• PUT /customers/39515

  {
    "firstname": "Christiaan"
  }
  

• POST /customers

  {
    "firstname": "test",
    "emailAddress": "[email protected]"
  }
  

• DELETE /customers/39515

The HTTP verb can be overriden using _method query parameter and you may send the parameters in the url as well.

• GET /customers/39515?_method=PUT&firstname=Christiaan
• GET /customers?_method=POST&firstname=test&[email protected]
• GET /customers/39515_method=DELETE

(read more about RESTful conventions)

• GET /emails/26597
• POST /emails/26597/sendToCustomer

  {
    "customerId": 328191
  }
  

The last example is a custom action on a single resource. That is only allowed using POST.

Representation

Expect an array of objects when 200/201 or an object with a message property when an error occurred.

HTTP statusses as you would expect from a RESTful webservice remain intact.

node-clang-rest's Issues

pluralize object in URL

Init Clang API before start web service

Make POST do a lookup on customer and either create or update

POST on node.leadstoloyals.com/clang/customer/?firstname=qwerty&externalId=xyz&emailAddress=[email protected]

This should do a lookup for a customer on externalId first.
If none is found, do a lookup on emailAddress
If still none is found, do a create otherwise do an update on the first found

More on restfulness and custom actions
-http://stackoverflow.com/questions/630453/put-vs-post-in-rest
-http://stackoverflow.com/questions/10885152/rest-shouldnt-put-create-and-post-update
-http://microformats.org/wiki/rest/urls

Implement DELETE verb for Clang

uuid remains in application until app is restarted

Currently once an uuid is supplied it remains active for everybody how connects until the app is restarted (which you cannot do from the web)

This can be fixed by using sessions where the uuid is only valid in the user's session.

let the interface describe itself

Not sure how to use this in the URL

Abstract away clang

This app should allow the wrapping of other SOAP API's as well. All SOAP API should be wrapped in such a ways that they lead to a consisten and uniform RESTful JSON API.

conform output to some standard json api format

Implement POST verb for Clang

come up with better name like node-rest-soap

Where Clang would be just one SOAP API

Custom action should be available for POST only

Better logging

Implement PUT verb for Clang

implement manualOptions pass through for email_sendToCustomer

Allow for custom actions like sendToCustomer (e.g. on email resource)