Service

This page contains an example implementation for a REST endpoint of a Service Provider, using the token obtained from the iSHARE /token endpoint and the delegation evidence obtained from the /delegation endpoint.

Example endpoint for Service Provider (parameters apply to other HTTP methods as well)

get

This is an example service (business specific) endpoint to show how any Service Provider that adheres to iSHARE MUST apply iSHARE conformant OAuth to every iSHARE enabled service. Request can make use of any HTTP method and can contain any extra headers. For convenience this documentation only defines the GET method. Parameters are undefined because they vary for each Service Provider due to their business specific logic. Note: Additional headers for security, statefulnes, application functionality could be added and is out of scope of this specification.

Authorizations

Header parameters

delegation_evidencestringOptional

iSHARE delegation evidence regarding the requested service. The Service Consumer can obtain this evidence from an Authorization Registry / Entitled Party before requesting a specific service.

service_consumer_assertionstringOptional

iSHARE specific optional client assertion. Used when a Service Consumer is requesting a service on behalf of another Service Consumer in a 'service broker' pattern. It is used to prove that the 'brokering' Service Consumer indeed has had a request from the original Service Consumer

LicensePurposestringOptional

Optional iSHARE specific value describing the purpose of the license the Service Consuming Entity requests for the data in the service response

Service-HeadersstringOptional

Any service specific headers

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /service HTTP/1.1
Host: isharetest.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "service_content_1": "text",
  "service_content_n": "text"
}