Re: Web Services API: URL naming proposal

[Nigel Titley <..hidden..>]

Sorry for the delay in reply... been off sick, back now

On 18/11/11 13:52, Chris Travers wrote:
> Figure i will wade in here.  Hopefully others will follow.
>> 1. The base address mentioned by John was something like
>> 'http://myledger.com/ledgersmb/store/'. However, if we assume that the
>> login address of the 'http://myledger.com/ledgersmb/login.pl', there
>> may be an issue with the '/store/' part. Can we support that on all
>> servers, or does that not matter? Do we allow '/store.pl/' or any
>> other URL? ie. do we not consider that part of the API, other than
>> that it is a prefix?
> 
> i don;t think that would be a problem. I don't like store though
> because it is pretty unclear.  I would suggest a base path of:
> 
> http://myhost/ledgersmb/webservices/company_name/
> 
> Then http auth headers can be used for the rest.

Why wouldn't we use http auth headers to select the "company" (I prefer
company too, rather than store). Just asking, I don't have strong views
either way.

>>
>> 2. Since companies are separate databases, where do we put the name of
>> the company in the URL? <prefix>/store.pl/<company>/<etc...>?
>>
> What do you think of the above proposal?
>>
>> Are there other items to consider before we go to specify the web
>> service behaviour of our natural/legal entity storage paradigm?
>>
> 
> I think the key issue is designing a logical entity hierarchy for
> things. Otherwise I don't see any other issues that will come up in
> this preliminary stage.

Agreed.